15,534
edits
Changes
→See also
Creation of a pdf/html version of the manual
==Manual creation and generation==
Every now and then, the manual on the gramps-project website should be updated. This page explains how to create this manual. Information on how to do the translation is in [[Translating the Gramps User manual]]. Part of this text is already automized via Makefiles by typing in the <code>help</code> directory <code>make html</code>. The reason of this page is so people would understand why Makefiles do what they do, or to generate the manuals outside of the build system. From Gramps '''Version 3.0:''', we moved towards a community driven manual, the [[Gramps 3.0 Wiki Manual]]. To generate a html/pdf/docbook manual from this, [[Manual Generation 3.0|a new strategy must be followed]]
==Get latest version==
See [[Translating the Gramps User manual]]. You should have the SVN Git version locally. Obtain latest version of the translations with <code>svn upgit pull</code>. Now do <code>make</code> to generate the manual in all supported languages.
The directory <code>help</code>should now contain all manuals, the standard english one in <code>help/C/gramps.xml</code>. At the time of writing, manuals are available for locales:
* C (English) -- basis of other translations
* fr (French) -- complete
A python script ''htmlpdfmanual.py'' is given which can perform html and pdf creation automtically based on some constants on my systhem. This intention is to convert all functionality to the GRAMPS make files in the future.
All needed data (css, png, conf) is present in SVN Git in the <code>help/output</code> dir. To run the script, save it in <code>help/output</code> directory of your SVN Git version of GRAMPS Gramps (on linux only). Edit constants in this script as necessary (recreate for non-standard latin alphabets the fonts if those of SVN Git give errors).
All constants should be self-explanatory, except two:
*<code>admonimagepdf</code> should direct to the absolute path with quality png's (15mm wide) of the admon icons (note, tip and warning.png). You can direct it to the standard <code>admonimage</code> directory, but if you do that, the icons will look bad in the created pdfs.
*<code>fop_conf_fs</code> should direct to the custom made FOP configuration file (available in SVNGit). This is only needed if <code>languages_fs</code> constant is not empty. See below on what the configuration file must consist of.
Run the script, it will create a directory <code>2.2</code>, with all manuals as pdf and html, ready to upload to the site, or to test it yourself.
Note that in above all the paths are the relative paths '''as they should appear in the html'''. You still have to copy the correct directories in the correct place to view the html in a correct way.
Next, upload all html files, as well as the figures directory to the gramps-project website, and an image directory containing the admon graphics (Gramps xml only uses 'note.png', 'tip.png' and 'warning.png' at this moment), navigation graphics and splash picture, and upload the css as well.
Another option is to use a Python [[Manual Html Generation| test program]] to generate html-files from the Gramps Manual 3.0 wiki pages.
== PDF manual creation for West-European languages==
FreeSerif.xml
Repeat the above for the fonts FreeSerifBold, FreeSerifItalic, FreeSerifBoldItalic, FreeMono, FreeMonoBold, FreeMonoOblique, FreeMonoBoldOblique. The resulting xml files are in SVNGit, but should you have problems, regenerate them.
===Preperation: A custom FOP config file===
You find this file in GRAMPS SVN Gramps Git in dir <code>help/output</code>.We made a config file with the name <code>grampsfop.xconf</code>, and content (''change in following file <code>/path_to_gramps</code> into the absolute path where GRAMPS SVN Gramps Git is downloaded.''):
<nowiki>
The file myfile.fo can be deleted, and myfile.pdf uploaded to gramps-project website with a better name.
===See also===
* [[User manual]]
* [[Rollover for the manual]]
* [[Manual Generation 3.0]]
* [[Manual Generation 3.0 Prince]]
[[Category:Translators/Categories]]
[[Category:Developers/General]]
