Skip to content

netresearch/typo3-docs-skill / skills/typo3-docs

typo3-docs

Flagged

Use when TYPO3 extension documentation has to render on docs.typo3.org, which builds a manual from Documentation/guides.xml and reads no Settings.cfg (a single README.rst serves an extension too small for one): when an extension has no documentation yet, or when creating, editing or reviewing Documentation/*.rst, guides.xml, README.md or XLF translations, rendering docs with Docker, TYPO3 RST directives, screenshots, or XLIFF 2-space indentation (TYPO3 v14+).

FileKindSize
SKILL.mdskill md5.9 KB
assets/AGENTS.mdmarkdown11.7 KB
assets/guides.xml.distother1.8 KB
checkpoints.yamlconfig43.1 KB
evals/evals.jsonconfig23.1 KB
references/architecture-decision-records.mdmarkdown6.6 KB
references/asset-templates-guide.mdmarkdown2.8 KB
references/canonical-sources.mdmarkdown6.2 KB
references/code-structure-elements.mdmarkdown7.4 KB
references/coding-guidelines.mdmarkdown7.1 KB
references/content-directives.mdmarkdown7.6 KB
references/documentation-coverage-analysis.mdmarkdown7.6 KB
references/documentation-quality-checks.mdmarkdown3.5 KB
references/extraction-patterns.mdmarkdown23.3 KB
references/file-structure.mdmarkdown7.0 KB
references/guides-xml.mdmarkdown15.9 KB
references/intercept-deployment.mdmarkdown12.5 KB
references/render-guides-development.mdmarkdown8.8 KB
references/rendering.mdmarkdown17.3 KB
references/rst-syntax.mdmarkdown10.5 KB
references/screenshots.mdmarkdown13.1 KB
references/scripts-guide.mdmarkdown3.1 KB
references/text-roles-inline-code.mdmarkdown2.5 KB
references/typo3-directives.mdmarkdown16.0 KB
references/typo3-extension-architecture.mdmarkdown17.4 KB
references/upstream-docs-contribution.mdmarkdown7.5 KB
scripts/add-agents-md.shexecutablescript2.2 KB
scripts/analyze-docs.shexecutablescript12.0 KB
scripts/check-adr-coverage.shexecutablescript778 B
scripts/check-changelog-version-coverage.shexecutablescript1.7 KB
scripts/check-confval-completeness.shexecutablescript2.1 KB
scripts/check-guides-xml-schema.shexecutablescript4.0 KB
scripts/check-guides-xml-version-sync.shexecutablescript1.9 KB
scripts/check-required-doc-sections.shexecutablescript1.6 KB
scripts/check-rst-substitutions-resolve.shexecutablescript5.4 KB
scripts/check-screenshot-freshness.shexecutablescript2.5 KB
scripts/check-settings-documented.shexecutablescript1.5 KB
scripts/check-ui-surface-screenshots.shexecutablescript2.8 KB
scripts/check-untranslated-fluid-strings.shexecutablescript1.6 KB
scripts/check-version-match.shexecutablescript624 B
scripts/extract-all.shexecutablescript4.1 KB
scripts/extract-build-configs.shexecutablescript2.8 KB
scripts/extract-composer.shexecutablescript1.9 KB
scripts/extract-extension-config.shexecutablescript5.0 KB
scripts/extract-php.shexecutablescript5.1 KB
scripts/extract-project-files.shexecutablescript2.0 KB
scripts/extract-repo-metadata.shexecutablescript4.7 KB
scripts/extraction-dir.shexecutablescript1.7 KB
scripts/json-string.shscript921 B
scripts/render_docs.shexecutablescript1.0 KB
scripts/validate_docs.shexecutablescript6.2 KB
scripts/validate_headings.pyexecutablescript4.4 KB

references/content-directives.md

View on GitHub
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
<!-- SPDX-FileCopyrightText: Netresearch DTT GmbH -->

# Content Directives Reference

Routing tables, decision guides and observed pitfalls for TYPO3 content
directives. Syntax lives upstream — canonical sources (win on conflict, see
`canonical-sources.md`):
- https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Accordion.html
- https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Admonitions.html
- https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Cards.html
- https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Tabs.html
- https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Tables.html
- https://docs.typo3.org/permalink/h2document:versions
- https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/ViewHelper.html

## When to Use What

| Content Type | Directive | Use Case |
|--------------|-----------|----------|
| Collapsible sections | `accordion` | FAQ-style content, optional details |
| Warnings/notes | Admonitions | Important notices, tips, cautions |
| Overview grids | `card-grid` | Feature lists, navigation pages |
| Alternative code | `tabs` | Multi-language examples, version variants |
| Structured data | Tables | Comparisons, reference data |
| Version info | `versionadded` | API changes, new features |
| Fluid docs | `typo3:viewhelper` | ViewHelper reference |

## Accordion

Syntax and options (`accordion`, `accordion-item` with `:name:`, `:show:`,
`:header-level:`):
[Accordion](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Accordion.html)
`[upstream]`. Note: there is no `:open:` option — an earlier version of this
file invented one.

### Best Practices

- Use for FAQ sections
- Use for optional, supplementary information
- Use for long content that would break reading flow
- Do NOT use for critical information users might miss

## Admonitions

Types and syntax (`note`, `tip`, `warning`, `attention`, `seealso`; `hint`/
`caution`/`danger` as alternatives — upstream prefers `tip` over `hint`):
[Admonitions](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Admonitions.html)
`[upstream]`. `important` and `error` are NOT documented upstream — render
before using them.

### Options — unverified

`[regression]` Upstream's Admonitions page documents **no** options.
`:title:`, `:class:`, `:name:` previously listed here are unverified — render
locally before relying on them.

### Decision Guide

| Situation | Use |
|-----------|-----|
| Background context | `note` |
| Helpful suggestion | `tip` |
| Potential problems | `warning` |
| Data loss risk | `danger` |
| Related resources | `seealso` |
| API deprecation | `deprecated` (version directive) |

## Cards

`card-grid`, `card`, `card-footer` (`:button-style:` incl. `stretched-link`)
and `card-image` (`:alt:`, `:position:`):
[Cards](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Cards.html)
`[upstream]`. Previously listed here but NOT documented upstream (verify by
render before use): `:columns-lg:`, `:headline-level:`, `:link:`.

## Tabs

`..  tabs::` with inner `..  group-tab::`; tab changes synchronize across all
tab groups on the page:
[Tabs](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Tabs.html)
`[upstream]`. (`..  tab::` is not documented upstream — do not use it.)

### Best Practices

- Use consistent tab names for synchronization
- Keep tab content comparable in scope
- First tab should be the most common/recommended option
- Do NOT nest tabs inside tabs

## Tables

Simple, grid and `csv-table` forms:
[Tables](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Tables.html)
`[upstream]`.

### t3-field-list-table (TYPO3 Specific)

`[upstream]` — documented on the Tables page, **with a caveat the old copy
here hid**: it is a custom directive that should not be used when the RST
must also render on other platforms (e.g. GitHub); plain tables are portable.

### Table Options

`[upstream]` documents `:header:`, `:widths:`, `:header-rows:`. Previously
also listed here but unverified upstream: `:width:`, `:class:`, `:name:` —
render before relying on them.

### Decision Guide

| Scenario | Table Type |
|----------|------------|
| Quick 2-3 column | Simple table |
| Complex merging | Grid table |
| External data | csv-table |
| TCA/field docs | t3-field-list-table |

## Version Directives

`versionadded` / `versionchanged` / `deprecated`, incl. nesting inside
admonitions:
[Versions](https://docs.typo3.org/permalink/h2document:versions)
`[upstream]`. Write the directive for the release you are building — see
`rst-syntax.md` ("Version Directive Accuracy").

## ViewHelper Documentation

`[upstream]` Document Fluid ViewHelpers with the `typo3:viewhelper` directive
— it renders the argument list **automatically from a JSON file** produced by
the fluid-documentation-generator; do not hand-write per-argument `confval`
blocks or `rubric` argument tables (that is the legacy Sphinx-era pattern and
does not render as intended). Canonical reference:
[ViewHelper directive](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/ViewHelper.html)

```rst
..  typo3:viewhelper:: RenderViewHelper
    :source: _Json/RenderViewHelper.json
    :sortBy: name
```

| Option | Purpose |
|--------|---------|
| `:source:` | Path to the JSON file with the ViewHelper data (`argumentDefinitions`) |
| `:sortBy:` | Argument ordering: `name` (alphabetical) or `json` (file order) |
| `:noindex:` | Prevent indexing when the same ViewHelper appears multiple times |

## Comments and Special Characters

[Comments](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Comments.html)
and
[Special characters](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/SpecialCharacters.html)
`[upstream]`. Skill rule (`[regression]`): `.. todo::` must not survive into
published documentation — resolve it or demote to a comment (see
`rst-syntax.md`).

## Pre-Commit Checklist

1. ✅ Admonitions use correct type for message severity
2. ✅ Cards have consistent structure in grid
3. ✅ Tabs use matching names for synchronization
4. ✅ Tables use appropriate syntax for complexity
5. ✅ Version directives include version number
6. ✅ Deprecated items mention replacement and removal version
7. ✅ Accordion items have unique names
8. ✅ All directives properly indented (4 spaces)

## References

- **Accordion:** https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Accordion.html
- **Admonitions:** https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Admonitions.html
- **Cards:** https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Cards.html
- **Tabs:** https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Tabs.html
- **Tables:** https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Tables.html
- **Versions:** https://docs.typo3.org/permalink/h2document:versions
- **ViewHelper:** https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/ViewHelper.html
writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 322kUpdated Claude CodeCodexVerifiedInstall
xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release.Stars: 118kUpdated Claude CodeCodexVerifiedInstall