Skip to content

heversonvasconcelos/wiki_publisher_redmine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wiki Publisher Redmine

DESCRIPTION

Wiki Publisher Redmine is a Redmine plugin that publishes project documentation into wiki pages.

INSTALLATION

This plugin uses some stored settings, so the database will have to be modified in the installation.

For more information on how to install a Redmine plugin, see Redmine Plugins

CONFIGURATIONS

The only configuration needed, is a relative url where documentation is located in the SCM repository.
This url is defined in “Wiki Publisher” tab at project configuration.

Projects → My Project → Settings → Wiki Publisher

The default value of field named “Design Repository URL” is setted as “trunk/design”,
following some conventions where Wiki Publisher Redmine was initially developed.

DEPENDENCIES

Redmine SCMacros

Wiki Publisher Redmine uses wiki macros that are not recognized by Redmine by default.
The repo_include macro used is from another plugin, Redmine SCMacros
This macro includes a file from repository (svn, git, etc) in the project wiki.

Example:


{{repo_include(design/gpr/index.textile)}}

USAGE

Assuming that the project repository and Wiki Publisher Redmine url are properly configured (check the configuration section above),
click on the link “Import From Repository” in the wiki edit page.

The plugin will try to find all wiki files (default is *.textile) in the given “Design Repository URL”.
After that, it will automatically create a wiki page for each wiki file found.

COMPATIBILITY

This plugin was developed using Redmine 1.3.2 and was not tested with another version.
For while, the only SCM supported is Subversion SVN.

TODO

It must be extended to support others SCM like Git, Mercurial, Bazaar, etc.

REFERENCES

The solution to create a project settings tab, was found in Redmine DMSF Plugin
The Redmine Wiki Publisher uses an adapted class ProjectTabsExtended from redmine_dmsf.

About

This is a plugin for Redmine that publishes project documentation into wiki

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages