pdftoc
Last modified by Lucas Charpentier on 2026/10/27 10:29
Audit
- Macro ID
- pdftoc
- Source
- XS
- Type
- Generator
- Classification reason
- Internal macro whose output, the table of contents of a PDF export, comes from the export job.
- Status
- Reviewed
- Criteria version
- 15.20
- XWiki version
- 18.8.0
- Audit date
- 2026-10-20
- Auditor
- Compared macros
Lucas CharpentierSources
Where to gather the information the criteria are checked against, see Gather the sources.
| Source | What it gives | Used for | Where |
|---|---|---|---|
| Documentation | Parameters, default values and examples, including the most common example | L2, L3, and the criteria measured with the most common example | Not recorded yet: search extensions.xwiki.org |
| Source code | How the macro declares its parameters and content: types, groups, features, advanced and hidden flags, constraints, content type, inline support | C4, C5, C7, C8, C9, C13, E4, E6 | https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-export/xwiki-platform-export-pdf/xwiki-platform-export-pdf-api/src/main/java/org/xwiki/export/pdf/internal/macro/PDFTocMacro.java |
| Macro descriptor | What the Edit Macro dialog is built from, on design.xwiki.org | D1, D2, C1 to C9, E4 | Descriptor, list of macros with their categories |
| Translations | The name, description and parameter names in each language | D1, D2, D4, C1 | l10n.xwiki.org |
| Uses in XWiki pages | How XWiki itself uses the macro, a realistic example when the documentation has none | L3, C2, C3, C6, C8, C9 | Search the xwiki organization on GitHub |
| Compared macros | The audits of the macros of the same type | L1, D3 | Fill Compared macros |
| Other sources specific to this macro |
|---|
| Criterion | Result | Notes |
|---|---|---|
| D1 wording | N/A | |
| D2 summary | N/A | |
| D3 category | N/A | |
| D4 quick-action | N/A | |
| L1 consistency | N/A | |
| L2 doc-parameters | N/A | |
| L3 doc-example | N/A | |
| I1 pattern | N/A | |
| I2 zero-config | N/A | |
| I3 instant | N/A | |
| I4 cursor | N/A | |
| I5 focus | N/A | |
| E1 wysiwyg | N/A | |
| E2 errors | N/A | |
| E3 nesting | N/A | |
| E4 inline-support | N/A | |
| E5 empty | N/A | |
| E6 inplace | N/A |
Parameters
| Parameter | C1 clarity | C2 mandatory | C3 defaults | C4 input-assistance | C5 groups | C6 order | C7 alternatives | C8 advanced | C9 technical | C13 constraints | Notes |
|---|---|---|---|---|---|---|---|---|---|---|---|
| depth | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
| jobId | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
Other notes
Internal macro: the PDF export inserts it in the generated document to build the table of contents of the export, from its export job. Its implementation is in an internal package, org.xwiki.export.pdf.internal.macro.PDFTocMacro, it is not documented, and it is missing from the Insert Macro dialog and Quick Actions of the audit instance, as an internal macro should be. Users never insert or edit it, so every criterion is N/A.
Known issues of this macro
No known issue is specific to this macro.
68 more known issues affect every macro: see the Known issues.
