[[PageOutline(2-5,Contents,pullout)]] = GtkDocPlugin = == Description == The idea of the plugin is to integrate gtkdoc books into trac's interface. This is accomplished, currently, by displaying the actual html output of gtkdoc, as well as integrating into the search engine in trac. There's three new user permissions in this plugin, GTKDOC_SEARCH, GTKDOC_VIEW, and GTKDOC_ADMIN. GTKDOC_VIEW and GTKDOC_SEARCH is obviously to view and respectively to search in the api, where GTKDOC_ADMIN allows the addition and removal of books. As mentioned above the admin_interface provides an interface for adding and removing books. Books are keyed on a name given to them at the time they're added, as well as an absolute path on the local filesystem of where the book actually is. This way, you can update the documentation (with rsync for example) and not have to touch a thing in trac. See also: * [http://gary-kramlich.livejournal.com/10776.html original announcement] == Bugs/Feature Requests == Existing bugs and feature requests for GtkDocPlugin are [report:9?COMPONENT=GtkDocPlugin here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=GtkDocPlugin&owner=lsaavedr new ticket]. == Download == Download the zipped source from [download:gtkdocplugin here]. == Source == You can check out GtkDocPlugin from [http://trac-hacks.org/svn/gtkdocplugin here] using Subversion, or [source:gtkdocplugin browse the source] with Trac. == Example == [http://www.gnugts.org/ gnugts.org] == Installation == Please follow [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin documentation] on how to install Trac's plugins. == Recent Changes == [[ChangeLog(gtkdocplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:lsaavedr] [[BR]] '''Maintainer:''' [wiki:lsaavedr] [[BR]] '''Contributors:''' Gary Kramlich [http://hg.guifications.org/extras/file/2bc8f2aedef7/trac/gtkdoc/tracgtkdoc tracgtkdoc]