From 96ade6c2fbb6ecf01424d7fd373330d3ea437b08 Mon Sep 17 00:00:00 2001 From: Baptiste PERRAUD Date: Mon, 5 Dec 2016 12:02:22 +0100 Subject: [PATCH] New README for the Opale to hdoc --- hdoc_to_pdf/README.md | 61 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 hdoc_to_pdf/README.md diff --git a/hdoc_to_pdf/README.md b/hdoc_to_pdf/README.md new file mode 100644 index 0000000..87972ec --- /dev/null +++ b/hdoc_to_pdf/README.md @@ -0,0 +1,61 @@ +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 +------- + +* Raphaël Debray + +* Baptiste Perraud + + +Dependance +---------- + + +This project can be used alone if you only want to convert a hdoc file into a PDF file. + + +User documentation +------------------ + + + + +Known bugs +---------- + + + +Todo +---- + +* 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) +* 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 +--------------- + +* The backlog of the current project is at the following url: https://framemo.org/NF29_Opale_to_Pdf +* The user stories of the current project are at the following url: https://bimestriel.framapad.org/p/NF29_Opale_to_Pdf_userstory + + + +Capitalisation +-------------- + + -- GitLab