1.1. Docbook and maven
I was looking for a maven plugin that produces documentation with syntax highlighting from docbook .
1.2. For the impatient
This article has been written in docbook , and generated via maven with the docbkx maven plugin .
You can check it out
as multi pages html
as a single html page
You can download a ready-to-build maven project here http://www.springfuse.com/blog/docbook/docbook-1.0.0-src.zip . It is ready to be customized for your needs.
Very nice Spring-Intro! Worth to become part of the official documentation.
"To start off with my new (Enterprise) Java Development Blog here on StSMedia.net I would like to gradually develop a sample application which demonstrates various aspects of the Spring framework and some of its related projects and products."
Five Minute Introduction
(Note that the actual manual is located here. Also note that this plugin has not been made available through the central Maven repository yet; you should instead add http://agilejava.com/maven/ to your list of repositories.)
The Docbkx Tools project provides a number of tools for supporting DocBook in a Maven environment. This may seem odd to you, since 1) Maven 2 is supposed to support DocBook natively, relying on Doxia, and 2) there is already another DocBook plugin at mojo.codehaus.org.
The thruth however is that DocBook support in Doxia is fairly limited, mainly because Doxia as a framework supports only a small fraction of the concepts found in DocBook. The subset of DocBook supported by Doxia is not even close to simplified DocBook.
The DocBook plugin at mojo.codehaus.org is supporting a wider range of DocBook markup, and is in fact more similar to the DocBook tools provided with this project. There are however some significant differences:
* The focus is on ease of use.
* You should not be required to install additional stuff to your hard disk in order to generate content from your DocBook sources. Simply adding a reference to the plugin in your POM should be sufficient.
* This project focuses on providing dedicated support for particular DocBook XSL stylesheet distributions. That means you can rely on the dedicated parameterization mechanism of Maven Plugins to pass in the XSLT parameters defined for a particular version and type of XSLT stylesheet.
* In the DocBook Plugin found at mojo.codehaus.org, you will be required to download a specific version of the DocBook XSL stylesheets manually. The plugins packaged contain the stylesheets as well. (In this project, a particular version of the stylesheets is closely tied to a particular version of the plugin. That you means you can always rely on the plugin's documentation to know which parameters you could pass in.)
* The DocBook plugin found at mojo.codehaus.org requires you to have access to the Internet in order allow the plugin to resolve URI's. The plugins provided in this project act differently: if your DocBook sources are referening to a DTD, then you can simply add a dependency to a jar file containing the DTD and related entities, and the plugin will make sure that all references will be resolved correctly.
Docbook2odf is a toolkit that automaticaly converts DocBook to OASIS OpenDocument (ODF, the ISO standardized format used for texts, spreadsheets and presentations). Conversion is based on a XSLT which makes it easy to convert DocBook->ODF, ODT, ODS and ODP as all these documents are XML based.
Also goal of docbook2odf is to generate well formatted documents in OpenDocument, ready to be used in instant, with actually considering current rules of the Corporate Identity of organizations. Final results should not be restricted to text like documents but also many other forms could be generated, like presentations, charts or forms with images and multimedia.
The result is provided in a one zipped ODF file (.odt/.odp/.ods) with all required content. There are group of utilities like docbook2odt, docbook2ods and docbook2odp as docbook2odf is actually universally converting to these respective formats.
Docbook2odf is open source. This means that the source codes is not only available for download free of charge, but developers have access to the source code and may modify it.
JAutodoc is an Eclipse Plugin for automatic adding Javadoc and file headers to your source code. It optionally generates initial comments from element name. Starting with Release 1.3 of JAutodoc it is possible to define Velocity templates for Javadoc and file headers.
While Subversion will do a fine job of storing all of the files you want revisioned, it can do quite a bit more. For example, it could send an eMail to a list of users every time a commit is made, to help ensure that at least one more set of eyeballs looks at critical bits of code before they get deployed into production environments. It can allow some users (but not others) to alter some properties (but not others). It can automatically attempt a recompile of code on a particular branch whenever commits are made, inform users as to the outcome of that compile, and even push those changes to a test machine for live experimentation. Subversion's triggers, or hook scripts, can be as simple or as complex as you desire.
Maven DocCheck Plugin is a report-type plugin for Apache Maven. It will create and register a report on missing and corrupt javadoc comments using the Sun Doc Check Doclet.
Generates documentation for the Java code in the project using the Doc Check Doclet. The default settings will suit many projects, and simply entering maven doccheck will create the standard documentation.
The topic of technical publishing is relatively new to the world of Eclipse. One can make the argument that technical publishing is just another collaborative development process involving several people with different backgrounds and skills. This article will show that the Eclipse platform is a viable platform for technical publishing by discussing how to write documents such as an article or a book within Eclipse. In fact, this article was written using Eclipse.
Stylebase for Eclipse is an open source tooling environment for software architects and designers. Stylebase is a reuse repository for architectural models and design patterns and it assists in applying quality-driven architecture design into software engineering. The tools are extensions to Eclipse, the most widely-used open source integrated development environment. We believe that Stylebase for Eclipse helps to improve the quality of software products and also increases reuse and information sharing in local and distributed development teams.
Hyperic HQ software delivers unparalleled visibility for web infrastructure to today’s IT professional. Hyperic HQ is an easy to use portal designed to auto-discover and start managing your infrastructure with one click. Open source, and available free through the industry preferred GPL license, we also offer our Silver Support package which includes additional, low cost business hours support.
WinShell is a free multilingual integrated development environment (IDE) for LaTeX and TeX. The program includes a text editor, syntax highlighting, project management, spell checking, a table wizard, BibTeX support, Unicode support, different toolbars and user configuration options. It is not a LaTeX system; an additional LaTeX package is required.
LaTeX Editor, called later LEd, is a free environment for rapid TeX and LaTeX document development.
LaTeX Editor is designed to work on Windows® 95/98/Me/NT4/2000/XP/2003 operating systems. LEd's capabilities vary according to the operating system used, e.g., Visual Styles from Windows® XP. It, however, works with almost all functionality also on Windows® 95.
Dopus is a Docbook publishing framework. It was designed with portability and extensibility in mind. Dopus can run on any Windows or Unix platform that supports Java.
Dopus was developed during a project for T-Systems Germany. T-Systems generously agreed to open source the newly developed parts of Dopus (Ant script and Docbook customization layer) for which we are very gratefull.
We have agreed to host Dopus here on our website as a free product we want to give back to the Docbook community. The Dopus framework is distributed under the GNU General Public License. The various parts of the Dopus framework are distributed under their respective (free) licenses.
Dopus is still pretty young but is already used in various projects.