[[PageOutline(2-5,Contents,pullout)]]

= Add documentation to source code through Subversion

== Description

This plugin allows offline editing of wiki pages, and storage of documentation so that it is closer to the source code that it documents. It adds a Docs tab to the Trac project navigation bar. It is a wiki plugin where the wiki text is stored in the Subversion repository.

Key features:
 * Uses [http://docutils.sourceforge.net/rst.html RestructuredText] as a markup language.
 * Supports inline images and links.
 * Highlights source code using [https://github.com/google/code-prettify google-code-prettify].
 * Supports editing through Subversion and the Trac website.
 * Handles user permission using Subversion authorization.
 * Supports downloading binaries with proper mime-types for non-text files.

[[Image(docs.png, border=2)]]

== Source / Bugs / Feature Requests

See http://github.com/trac-hacks/tracdocs for more details and the source code, or to report issues or request features.

== Installation

This plugin can be installed with:
{{{#!sh
$ easy_install tracdocs
}}}

== 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:

{{{#!ini
[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` permission to control access to the documentation pages.

== Recent Changes

[[ChangeLog(tracdocsplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:mrjbq7] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''