2.4.5releasedDocumenter
Add documentation to your backend
Clone URLhttps://github.com/symphonists/documenter.git
Add as a submodulegit submodule add https://github.com/symphonists/documenter.git extensions/documenter --recursive
Compatibility
2.x.x | 2.1.x | 2.2.x | 2.3.x | 2.4.x | 2.5.x | 2.6.x | 2.7.0 | 2.7.1 | 2.7.2 | 2.7.3 | 2.7.4 | 2.7.5 | 2.7.6 | 2.7.7 | 2.7.8 | 2.7.9 | 2.7.10 |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
No | 1.0RC1 | 1.0RC1 | 2.1.2 | 2.2.0 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 | 2.4.5 |
Readme
Documenter
A Symphony extension enabling addition of documentation to any page in the backend, including user-defined section indexes and entry editors.
Usage
Managing Documentation
Documentation can be managed at System > Documentation
. For each documentation item, specify:
- The item's Title, used as the heading for the documentation drawer.
- The item's Content.
- The back-end Pages on which you'd like this item to appear.
Special styling
- Collapsible blocks: Documenter will automatically wrap the content between two
h3
headlines into a collapsible block. The headline is used to toggle the state of the following block. All blocks are closed by default but Documenter stores the current opening state of all content blocks in the browser'slocalStorage
and restores it on page refresh. Notes: You can add notes that are highlighted and never collapsed by wrapping it in a
div.note
, e. g.:<div class="note"><strong>Note:</strong> I'm just here to look important.</div>
Acknowledgement
This extension is not a work of a single person, a lot of people tested it and contributed to it.
Version history
Symphony 2.5.0 to 2.x.x
- Sanitize configuration values before output
Symphony 2.5.0 to 2.x.x
- Fix XSS possibility
- Prevent showing the "document it" when the text formatter is not markdown compatible
Symphony 2.5.0 to 2.x.x
- Supported on PHP 7
- Fix static problems
Symphony 2.5.0 to 2.x.x
- Limit class-less images to 100% width
Symphony 2.5.0 to 2.x.x
- Bug fixes
Symphony 2.5.0 to 2.6.x
- Added auto generate buttons that creates a text with field's name list
Symphony 2.5.0 to 2.6.x
- Symphony 2.5 compatibility
- Symphony 2.6 compatibility
Symphony 2.4.0 to 2.4.x
- Symphony 2.4 compatibility
Symphony 2.3.0 to 2.3.x
- Fix content block spacing
- Remove id on non-unique headlines
Requires Symphony 2.3
- Defined MYSQL Collation UTF Setting
Requires Symphony 2.3
- Merged advanced styling and behaviour from Johanna's fork
Requires Symphony 2.3
- Symphony 2.3 compatibility
Symphony 2.0.4 to 2.2.x