| 1 |
Principal: |
| 2 |
pdfBuild.py allows to create a pdf from a collection of issues created within invent.kde.org, the kde gitlab environment. |
| 3 |
Working with gitlab and its issues fonctionnality allows to provide the team with an environment to collaborate while working on a specification. Comments can be used and old designs are stored for logging purpose. |
| 4 |
Using pdfBuild.py ensures to always have the latest specification. |
| 5 |
|
| 6 |
Packages and modules to install in order to run pdfBuild.py: |
| 7 |
|
| 8 |
- pdflaxtex |
| 9 |
on debian based distribution: |
| 10 |
sudo apt install texlive-latex-extra |
| 11 |
|
| 12 |
- pylatex |
| 13 |
using pip: |
| 14 |
pip install pylatex |
| 15 |
|
| 16 |
-git |
| 17 |
|
| 18 |
How it works: |
| 19 |
pdfBuild.py first extracts the pdf structure from the following invent wiki page: |
| 20 |
https://invent.kde.org/education/gcompris/-/wikis/GComprisCPSpec/gcompris-control-panel-specification |
| 21 |
|
| 22 |
The structure is provided by a list of wiki links pointing to issues: |
| 23 |
example: |
| 24 |
- [Main screen overview](https://invent.kde.org/education/gcompris/-/issues/3) |
| 25 |
- [Connecting devices](https://invent.kde.org/education/gcompris/-/issues/5) |
| 26 |
- [Following results](https://invent.kde.org/education/gcompris/-/issues/6) |
| 27 |
|
| 28 |
In this example the first link points to the invent issue number 3. This one contains the text to be displayed in the final pdf specification and its illustrations. |
| 29 |
Illustrations are stored into the corresponding issues and are uploaded and updated directly within the issues interface. |
| 30 |
|
| 31 |
In order to get the wiki content, the scipt is using git to download the file https://invent.kde.org/education/gcompris.wiki.git . |
| 32 |
|
| 33 |
bugs: |
| 34 |
It is sometimes necessary to run the script twice to avoid the following file reading error: |
| 35 |
FileNotFoundError: [Errno 2] No such file or directory: './gcompris.wiki/GComprisCPSpec/GCompris-control-panel-specification.md' |
| 36 |
The second time git will correctly download the required files. |
| 37 |
This bug needs to be investigated |
| 38 |
|
| 39 |
Usage: |
| 40 |
python pdfBuild.py --wikiurl https://invent.kde.org/education/gcompris.wiki.git --outputFilename myGCSpecificationFile.pdflatex |
| 41 |
|
| 42 |
additional options to save build time: |
| 43 |
--doNotDownloadWiki (to use the wiki file already downloaded locally) |
| 44 |
--doNotDownloadIssuesImages (to use the image files from issues already downloaded locally) |
| 45 |
|
| 46 |
Improvements: |
| 47 |
Output files should be generated in a dedicated output directory. |
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
|