README.md 1.83 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Converter hdoc_to_pdf
-----------------------

The purpose of this converter is to obtain an PDF file from a hdoc document. 


License GPL3.0
--------------

http://www.gnu.org/licenses/gpl-3.0.txt


Credits
-------

16 17 18
*   2016
    - Raphaël Debray
    - Baptiste Perraud
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38


Dependance
----------


This project can be used alone if you only want to convert a hdoc file into a PDF file.


User documentation
------------------




Known bugs
----------



39
Generic Todo
40
------------
41 42 43 44

* Generate a clean PDF file (using the LaTeX formatting example)
    - Create a default CSS file with basic spine rules
    - Get the right free font (equivalent to the LaTeX's one)
45
* Generate the ToC according to the converted (by XSL) headings of the hdoc
46 47 48 49 50 51 52 53
* Handle as fully as possible of widows and girl orphans; trying to match Prince's layout and implementing the suitable CSS rules (which shall not be interpreted by FS)
* Allow the user to override some specific CSS rules, according to the main layout logical rules
* Bonus: find out a HTML editor to manually add line breaks to a hdoc file in order to resolve widows and girl orphans problems after the PDF file's generation


Technical notes
---------------

54 55 56 57 58 59
* The product backlog of the current project can be found through the following url: <https://framacalc.org/NF29_Opale_to_Pdf_PB>
* Time-sheets can be found through the following urls:
    - <https://framacalc.org/NF29_Opale_to_Pdf_fichetemps_PERRAUD>

User Story
----------
60

61 62 63 64 65
* L'utilisateur dispose d'un fichier hdoc en entrée, il veut obtenir un fichier pdf paginé en sortie.
* Il accède au convertisseur (dossier dédié) hdoc_to_pdf.
* Il place le fichier hdoc dans le dossier input.
* Il lance le script run.bat/run.sh ou exécute directement le script ant hdoc_to_pdf.ant.
* Il récupère le fichier pdf dans le dossier output.
66 67 68 69 70 71


Capitalisation
--------------