fj-doc-guides
Venus Guidelines : Doc Format Summary
Deprecation notice start
This guide has been deprecated and will not be maintained, now you can refer to the new official guide : (built it in the main Fugerit Venus Doc repository) :
Especially the Fugerit Doc Format entry point
Deprecation notice end
Version : 1 (2023-08-13)
Description
This page is an entry point for the Venus Document Format.
When writing a sample Venus Document, it is possible to draw from some online resources :
- Venus DOC XML Schema Definition - Current version of the Venus DOC XSD, the main source for writing valid Venus document meta model.
- Venus DOC XML Reference - the informations contained in the previous XSD in HTML format for convenience.
- Venus DOC meta informations reference - documentations for existing ‘info’ properties for ‘metadata’ section.
- The Venus Guides - Source for many examples and guidelines (this page of part of it!).
These resources should help you in writing the xml source document which can be used as input to Fugerit Doc Venus to output various formats.
Here is a very simple example of a xml document compliant with the Venus DOC XSD :
<?xml version="1.0" encoding="utf-8"?>
<doc
xmlns="http://javacoredoc.fugerit.org"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://javacoredoc.fugerit.org https://www.fugerit.org/data/java/doc/xsd/doc-2-0.xsd" >
<!--
This is a Venus Fugerit Doc (https://github.com/fugerit-org/fj-doc) XML Source Document.
For documentation on how to write a valid Venus Doc XML Meta Model refer to :
https://venusguides.fugerit.org/src/docs/common/doc_format_summary.html
-->
<metadata>
<!-- Margin for document : left;right;top;bottom -->
<info name="margins">10;10;10;30</info>
<!-- documenta meta information -->
<info name="doc-title">Hello World</info>
<info name="doc-author">fugerit79</info>
<info name="doc-language">en</info>
</metadata>
<body>
<para>Hello World!</para>
</body>
</doc>