netresearch/typo3-docs-skill / skills/typo3-docs
typo3-docs
FlaggedUse 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+).
references/text-roles-inline-code.md
View on GitHub<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
<!-- SPDX-FileCopyrightText: Netresearch DTT GmbH -->
# Text Roles and Inline Code
The role tables live upstream — do not restate them here. **Canonical sources
(win on conflict — see `canonical-sources.md`):**
- [Text roles](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/InlineMarkup/TextRoles/Index.html)
`[upstream]` — `:file:`, `:path:`, `:guilabel:`, `:kbd:`, `:abbr:`, the
TYPO3-specific roles (`:composer:`, `:issue:`, `:t3ext:`, `:t3src:`), and
the note that Docutils standard roles are supported
- [Inline code](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Code/InlineCode.html)
`[upstream]` — the language roles (`:php:`, `:php-short:`, `:typoscript:`,
`:tsconfig:`, `:fluid:`, `:html:`, `:css:`, `:js:`, `:bash:`), PHP-class
auto-linking to api.typo3.org, and the copy/selection behaviour of rendered
inline code
- [Cross-references](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Links/Documentation.html)
`[upstream]` — `:ref:` vs `:doc:` (prefer `:ref:`; `:doc:` breaks when a
section moves) and interlink syntax
## Unverified roles — do not assert without a render test
`[regression]` The upstream inline-code page documents exactly: php,
php-short, typoscript, tsconfig, fluid, html, css, js, bash. Roles this file
previously listed as available but which are **not documented upstream**:
`:xml:`, `:xliff:`, `:yaml:`, `:json:`, `:sql:`, `:rst:`, and the aliases
`:javascript:`/`:shell:`. Before using one of these in documentation, render
locally and check the log — an unknown role fails the build.
## Common Mistakes `[regression]`
The three failure modes actually observed in agent-written docs:
```rst
# ❌ Wrong: backticks for everything # ✅ Correct: typed role
``ImageResolverService`` renders images :php:`ImageResolverService` renders images
# ❌ Wrong: plain text for file paths # ✅ Correct
See ext_localconf.php for details See :file:`ext_localconf.php` for details
# ❌ Wrong: plain text for UI elements # ✅ Correct
Click the Save button Click the :guilabel:`Save` button
```
Menu paths: upstream's `:guilabel:` idiom is `Web > Pages` (with `>`);
`:menuselection:` with `-->` is a generic Sphinx role not documented on the
TYPO3 text-roles page — prefer `:guilabel:` with `>` for consistency.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| 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: 198k | Updated | Claude CodeCodex | Verified | Install |
| 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: 119k | Updated | Claude CodeCodex | Verified | Install |
| 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: 118k | Updated | Claude CodeCodex | Verified | Install |