wiki:TracDocsPlugin

Version 15 (modified by mrjbq7, 5 years ago) (diff)

--

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. The primary purpose behind this is to allow offline editing of wiki pages, and storage of documentation "closer" to the source code that it documents.

Some features:

  • Uses RestructuredText as a markup language.
  • Supports inline images and links.
  • Highlights source code using 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.

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

Recent Changes

[7900] by mrjbq7 on 2010-04-30 05:28:20
New hack TracDocsPlugin, created by mrjbq7

Author/Contributors

Author: mrjbq7?
Maintainer: mrjbq7?
Contributors:

Attachments (1)

Download all attachments as: .zip