[[PageOutline(2-5,Contents,pullout)]] = Documentation plugin for Trac = == Description == The TracDocsPlugin adds a Docs tab to the trac project. It is a wiki plugin where the wiki text is stored in the Subversion repository. Some features: * Uses [http://docutils.sourceforge.net/rst.html RestructuredText] as a markup language. * Supports inline images and links. * Highlights source code using [http://code.google.com/p/google-code-prettify google-code-prettify]. * Supports editing through Subversion and the Trac website. * Handles user permission using Subversion authorization. == Source == See http://github.com/mrjbq7/tracdocs for more details and the source code, or to report issues or request features. == Configuration == It is configured in the trac.ini file by enabling the component and configuring the path within the Subversion repository to store the wiki documents: {{{ [components] tracdocs.* = enabled [docs] root = wiki/trunk }}} By default, it will show the title of the directory that you are navigating, but if you create an index.txt file in the directory, it will use that instead, allowing you to put additional documentation at the top of a directory structure. It uses the WIKI_VIEW permissions to control access to the documentation pages. == Example == [[Image(docs.png)]] == Recent Changes == [[ChangeLog(tracdocsplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:mrjbq7] [[BR]] '''Maintainer:''' [wiki:mrjbq7] [[BR]] '''Contributors:'''