2.4.4releasedDocumenter

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.x2.1.x2.2.x2.3.x2.4.x2.5.x2.6.x2.7.0
No1.0RC11.0RC12.1.22.2.02.4.42.4.42.4.4

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:

  1. The item's Title, used as the heading for the documentation drawer.
  2. The item's Content.
  3. The back-end Pages on which you'd like this item to appear.

Special styling

  1. 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's localStorage and restores it on page refresh.
  2. 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

  • 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