nqDocumentation
Commonly documentation is needed in various languages, the editing process shall be distributed among a team and existing fragments linked into one document. The nqDoc editor was designed to fit these requirements.
MultilingualTranslate a document with the help of various tools. The editor provides an english and a german language pack by default. It can be extended with custom language packs.
Team Work
Chapters of a manual can be moved to separate
files. Due to the XML nature of nqDoc files documents can be checked into a
versioning system like CVS.
Reference source code and JavaDoc comments
Software manuals often contain code snippets.
The editor can link to existing source code, no copy - paste. The editor can
link to existing JavaDoc comments. Custom JavaDoc-Tags are supported to
partition and organize source code comments.
Extendable
Do you need support for a special language or
want to include data that is stored in your business database? Publish your
finshed documents in Tex? The editor is highly extendable due to its extension
points.
Content focused
In contrast to WYSIWYG ("What You See Is What You Get") WYSIWYM
("What You See Is What You Mean") means that the displayed information
only shows what purpose an element has, and not how the documents final layout
will look like. This kind of formatting is used
when the layout process is left to the application. Usually this way the
formatting gets much more consequent and appealing. On the other hand the user
does not have to care about the layout process and can concentrate on the
content of a document.
For more detail information:
