503 projects tagged "Documentation"
The docbookm package is contributed with LayManSys and contains very simple XSLT drivers for generating XHTML chunks from DocBook XML. This package does not require an installation; you only have to unzip the package's contents into a directory of your choice and start using it. There is no special documentation available. Use the file abstract.xsl for transforming an abstract and section.xsl for transforming sections. All other .xsl files are only includes needed by those two.
The PHP program inidoc is contributed with LayManSys, and is used internally for documenting configuration files in a so-called INI format. This file format is typically used for config files under MS Windows or by PHP Web applications. inidoc uses special comments in the INI files and generates DocBook XML output. The program's output format is DocBook XML, where each INI file is documented within a section. Normal text is put into para tags, and the key-value pairs are described using a glosslist.
The xsd2db package is used for converting XML Schema Definition files into DocBook XML code. The transformer can also be used to generate DocBook XML from plain XML files. It marks up tag names, attribute names, attribute values, and annotation, if parsing XSD code. The resulting DocBook XML code may be styled so that you have syntax highlighted XML code.
The docbooktoc.xsl is an XSLT file for generating an XHTML table of contents from DocBook XML documents. It is used by the LayManSys project for the documentation. docbooktoc generates an XHTML document containing the books' meta information (in DocBook XML, this is the subnode bookinfo) and then lists all of the books' chapters and sections in an ordered list. The meta information is both used for generating the head as well as the document header (in the XHTML body), and the output is the same as what the DocBook XSLT driver for XHTML generates.
SVN2Log automatically generates changelogs from a Subversion repository. You do not need to waste your time and write a special changelog document with a subset of features already described in your SVN commits' descriptions; you decide which parts will be displayed for your users.
Tartan is a text parsing engine targeted at wiki text. The syntax specification is defined in YAML in the form of regex-based rules. It supports layering and multiple output types. Rules for Markdown to HTML are included, with optional layered extensions for tables. It is implemented in Ruby, but looking to have implementations in other languages.
Lp4all allows you to document your code directly inside the language comments, using a simple Wiki-like syntax. It then generates an HTML browsable version of your code and documentation. It is similar to the traditional Noweb literate programming tool, except that Noweb doesn't work when one must use a specific third-party editor to edit the source code. In Lp4all, documentation is stored in the comments of the language: the original source code is still directly usable by the language compiler. Lp4all is also language-agnostic: it doesn't know anything about functions, methods, constants, or classes.
The Docbkx Maven Plugin allows you to generate different types of output from DocBook sources. Its main advantage over many other types of DocBook XSL based tools is that you don't need to install the tool or any of the other required tools at all to get it to work. As long as you have Maven 2 installed on your system, you're basically done.