Deprecated Content
Last modified by Eleni Cojocariu on 2026/08/26 11:16
In documentation, deprecated content must be marked as "deprecated" using the deprecated macro.
What is conidered "deprecated" content
Deprecated content documents a feature/code (or a part of it) that is still supported and bundled in the product, but:
- won't receive further improvements, only bug fixes to keep it working,
- developers should stop using deprecated APIs, as they'll eventually be moved to legacy modules,
- users should move to the replacement feature, since the code may be removed in the future (e.g., moved to a non-bundled extension).
When to use the "Deprecated" macro
- Use
{{deprecated}}when only part of a page is outdated: a parameter, UI element, or behavior, while the rest stays relevant. Don't use "version" macro for this; it has its own rules and isn't meant for marking deprecated content. - Deprecated content stays documented as long as it's bundled in XWiki Standard Once a feature is no longer maintained and falls out of the product, remove its docs after the 1-year period.
- Both macros can be combined:
{{version}}wrapped around{{deprecated}}. The{{version}}macro gets removed eventually, but{{deprecated}}stays as long as the feature is still bundled.
Syntax and parameters: "Deprecated" Macro.