Skip to content

Commit aaac62f

Browse files
committed
Tutorial update
1 parent 4cfa1bb commit aaac62f

25 files changed

+99
-869
lines changed

.github/workflows/continuous-integration-workflow.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,8 @@ jobs:
7474
sed -i "s/author:.*/author: v$(python setup.py -V 2>/dev/null)/" mkdocs.yml
7575
cp tutorial/notebook.ipynb docs/
7676
mkdocs build
77-
pdoc --html -o public/ fpdf
77+
pdoc --html -o public/ fpdf --config "git_link_template='https://github
78+
.com/PyFPDF/fpdf2/blob/{commit}/{path}#L{start_line}-L{end_line}'"
7879
cd contributors/ && PYTHONUNBUFFERED=1 ./build_contributors_html_page.py PyFPDF/fpdf2
7980
cp -t ../public/ contributors.html contributors-map-small.png
8081
- name: Deploy documentation 🚀

docs/Tables.md

+2
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@ Result:
154154

155155
![](table_with_single_top_line_layout.jpg)
156156

157+
All the possible layout values are described there: [`TableBordersLayout`](https://pyfpdf.github.io/fpdf2/fpdf/enums.html#fpdf.enums.TableBordersLayout).
158+
157159
## Insert images
158160
```python
159161
TABLE_DATA = (

docs/Tutorial-de.md

+4-14
Original file line numberDiff line numberDiff line change
@@ -144,29 +144,19 @@ Sobald det Text der dritten den oben beschriebenen Abstand zum Seitenende erreic
144144

145145
## Lektion 5 - Tabellen erstellen ##
146146

147-
In dieser Lektion zeigen wir, wie man auf einfache Weise Tabellen erstellen kann.
148-
149-
Der Code wird drei verschiedene Tabellen erstellen, um zu zeigen, welche Effekte wir mit einigen einfachen Anpassungen erzielen können.
150-
151147
```python
152148
{% include "../tutorial/tuto5.py" %}
153149
```
154150

155151
[Erzeugtes PDF](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
156152
[Länder](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
157153

158-
Da eine Tabelle lediglich eine Sammlung von Zellen darstellt, ist es naheliegend, eine Tabelle aus den bereits bekannten Zellen aufzubauen.
159-
160-
Das erste Beispiel wird auf die einfachste Art und Weise realisiert. Einfach gerahmte Zellen, die alle die gleiche Größe haben und linksbündig ausgerichtet sind. Das Ergebnis ist rudimentär, aber sehr schnell zu erzielen.
154+
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267
161155

162-
Die zweite Tabelle bringt einige Verbesserungen: Jede Spalte hat ihre eigene Breite,
163-
die Überschriften sind zentriert und die Zahlen rechtsbündig ausgerichtet. Außerdem wurden die horizontalen Linien
164-
entfernt. Dies geschieht mit Hilfe des Randparameters der Methode `cell()`, der angibt, welche Seiten der Zelle gezeichnet werden müssen.
165-
Im Beispiel wählen wir die linke (L) und die rechte (R) Seite. Jetzt muss nur noch das Problem der horizontalen Linie
166-
zum Abschluss der Tabelle gelöst werden. Es gibt zwei Möglichkeiten, es zu lösen: In der Schleife prüfen, ob wir uns in der letzten Zeile befinden und dann "LRB" als Rahmenparameter übergeben oder, wie hier geschehen, eine abschließende Zelle separat nach dem Durchlaufen der Schleife einfügen.
156+
English versions:
167157

168-
Die dritte Tabelle der zweiten sehr ähnlich, verwendet aber zusätzlich Farben. Füllung, Text und
169-
Linienfarben werden einfach mit den entsprechenden Methoden gesetzt. Eine wechselnde Färbung der Zeilen wird durch die abwechselnde Verwendung transparenter und gefüllter Zellen erreicht.
158+
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
159+
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)
170160

171161
## Lektion 6 - Links erstellen und Textstile mischen ##
172162

docs/Tutorial-es.md

+6-24
Original file line numberDiff line numberDiff line change
@@ -169,37 +169,19 @@ volverá a la primera columna, desencadenando un salto de página.
169169

170170
## Tutorial 5 - Creando tablas ##
171171

172-
Este tutorial explicará cómo crear tablas fácilmente.
173-
174-
El código creará tres tablas diferentes para explicar lo que
175-
puede lograrse con algunos cambios sencillos.
176-
177172
```python
178173
{% include "../tutorial/tuto5.py" %}
179174
```
180175

181176
[PDF resultante](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
182177
[Archivo de texto con países](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
183178

184-
Dado que una tabla es solo una colección de celdas, es natural construir una
185-
a partir de ellas.
186-
187-
El primer ejemplo se logra de la forma más básica posible: simples celdas
188-
enmarcadas, todas del mismo tamaño y alineadas a la izquierda. El resultado es rudimentario pero
189-
muy rápido de obtener.
190-
191-
La segunda tabla incluye algunas mejoras: cada columna tiene su propio ancho,
192-
los títulos están centrados y las figuras alineadas a la derecha. Es más, las líneas horizontales han
193-
sido removidas. Esto es hecho por medio del parámetro `border` del método
194-
`Cell()`, el cual especifica qué lados de la celda deben dibujarse. Aquí queremos
195-
el izquierdo (`L`) y el derecho (`R`). Ahora solo queda el problema de la línea horizontal
196-
para terminar la tabla. Hay dos posibilidades para resolverlo: encontrar
197-
la última línea en el ciclo, en cuyo caso usamos LRB para el parámetro
198-
`border`; o, como se hizo aquí, agregar la línea una vez el ciclo ha terminado.
199-
200-
La tercera tabla es similar a la segunda, pero usa colores. Los colores de relleno,
201-
texto y línea son especificados de manera simple. Un coloreado alternante para las filas es obtenido
202-
usando de forma alternada celdas transparentes y rellenas.
179+
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267
180+
181+
English versions:
182+
183+
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
184+
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)
203185

204186
## Tutorial 6 - Creando enlaces y combinando estilos de texto ##
205187

docs/Tutorial-fr.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -110,24 +110,21 @@ En utilisant la méthode [accept_page_break](fpdf/fpdf.html#fpdf.fpdf.FPDF.accep
110110
Une fois que la limite inférieure de la troisième colonne est atteinte, la méthode [accept_page_break](fpdf/fpdf.html#fpdf.fpdf.FPDF.accept_page_break) sera réinitialisée et retournera à la première colonne. Cela déclenchera un saut de page.
111111

112112
## Tuto 5 - Créer des tables ##
113-
Ce tutoriel explique comment créer facilement des tableaux.
114-
115-
Le code créera trois tableaux différents pour expliquer ce qui peut être réalisé avec quelques modifications.
113+
Ce tutoriel explique comment créer facilement des tableaux. Deux tableaux différents sont générés, pour illustrer ce qui peut être produit avec de très simples changements.
116114

117115
```python
118116
{% include "../tutorial/tuto5.py" %}
119117
```
120118

121119
[PDF généré](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
122-
[Liste de pays](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
123-
124-
Comme un tableau n'est qu'une collection de cellules, il est naturel d'en construire un à partir de celles-ci.
125-
126-
Le premier exemple est réalisé de la manière la plus basique qui soit : de simples cellules encadrées, toutes de même taille et alignées à gauche. Le résultat est rudimentaire mais très rapide à obtenir.
120+
[Données CSV des pays](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
127121

128-
Le deuxième tableau apporte quelques améliorations : chaque colonne possède sa propre largeur, les titres sont centrés et les chiffres alignés à droite. De plus, les lignes horizontales ont été supprimées. C'est fait grâce au paramètre `border` de la méthode [`.cell()`](fpdf/fpdf.html#fpdf.fpdf.FPDF.cell) qui spécifie quels côtés de la cellule doivent être dessinés. Ici, nous voulons les côtés gauche (`L`) et droit (`R`). Il ne reste plus que le problème de la ligne horizontale pour terminer le tableau. Il y a deux possibilités pour le résoudre : vérifier la dernière ligne dans la boucle (dans ce cas nous utilisons `LRB` pour le paramètre de bordure) ou, comme fait ici, ajouter la ligne une fois la boucle terminée.
122+
Le premier exemple est généré de la façon la plus simple possible, en fournissant des données à [`FPDF.table()`](https://pyfpdf.github.io/fpdf2/Tables.html). Le résultat est rudimentaire, mais très rapide à obtenir.
129123

130-
Le troisième tableau est similaire au deuxième mais utilise des couleurs. Les couleurs de remplissage, de texte et de ligne sont simplement spécifiées. Une coloration alternative pour les lignes est obtenue en utilisant des cellules alternativement transparentes et remplies.
124+
Le second tableau introduit quelques améliorations : couleurs, largeur réduite de la table, moindre hauteur des lignes de texte, titres centrés, colonnes avec des largeurs propres, nombres alignés à droite...
125+
De plus, les lignes horizontales ont été supprimées.
126+
Cela grâce à la sélection d'un `table.borders_layout` parmi les valeurs disponibles :
127+
[`TableBordersLayout`](https://pyfpdf.github.io/fpdf2/fpdf/enums.html#fpdf.enums.TableBordersLayout).
131128

132129
## Tuto 6 - Créer des liens et mélanger différents styles de textes ##
133130
Ce tutoriel explique plusieurs façons d'insérer des liens à l'intérieur d'un document pdf, ainsi que l'ajout de liens vers des sources externes.

docs/Tutorial-gr.md

+4-9
Original file line numberDiff line numberDiff line change
@@ -109,24 +109,19 @@ pdf.cell(60, 10, 'Powered by FPDF.', new_x="LMARGIN", new_y="NEXT", align='C')
109109

110110
## Μάθημα 5 - Δημιουργία Πινάκων ##
111111

112-
Σε αυτό το μάθημα θα εξηγήσουμε πως να δημιουργούμε εύκολα πίνακες.
113-
114-
Ο κώδικας θα δημιουργήσει τρεις διαφορετικούς πίνακες έτσι ώστε να παρουσιάσουμε τι μπορεί να επιτευχθεί με μερικές απλές προσαρμογές.
115-
116112
```python
117113
{% include "../tutorial/tuto5.py" %}
118114
```
119115

120116
[Παραγόμενο PDF](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
121117
[Κείμενο Χωρών](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
122118

123-
Εφόσον ένας πίνακας αποτελεί μία συλλογή από κελιά, είναι φυσικό να τον κατασκευάσουμε από αυτά.
124-
125-
Το πρώτο παράδειγμα επιτυγχάνεται με τον πιο απλό τρόπο: πλαισιωμένα κελιά, ίδιου μεγέθους και αριστερά στοιχισμένα. Το αποτέλεσμα είναι υποτυπώδες αλλά αποκτάται αρκετά εύκολα.
119+
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267
126120

127-
Ο δεύτερος πίνακας παρουσιάζει ορισμένες βελτιώσεις: κάθε στήλη έχει το δικό της πλάτος, οι τίτλοι είναι κεντραρισμένοι και οι αριθμοί δεξιά στοιχισμένοι. Επιπλέον, οριζόντιες γραμμές έχουν αφαιρεθεί. Αυτό επιτυγχάνεται με την παράμετρο border της μεθόδου Cell(), η οποία ορίζει ποιες πλευρές του κελιού χρειάζεται να σχεδιαστούν. Στη συγκεκριμένη περίπτωση θέλουμε τις αριστερές (L) και τις δεξιές (R). Τώρα απομένει μόνο το πρόβλημα των οριζόντιων γραμμών. Μπορούμε να το λύσουμε με δύο τρόπους: να ελέγξουμε την τελευταία γραμμή στο βρόχο επαναλήψεων, οπότε θα χρησιμοποιήσουμε LRB για την παράμετρο border ή, όπως πράξαμε εδώ, να προσθέσουμε την γραμμή όταν τελειώσει ο βρόχος επαναλήψεων.
121+
English versions:
128122

129-
Ο τρίτος πίνακας είναι παρόμοιος με τον δεύτερο αλλά χρησιμοποιεί χρώματα. Τα χρώματα του γεμίσματος, του κειμένου και των γραμμών ορίζονται ξεχωριστά. Ο εναλλασσόμενος χρωματισμός των γραμμών του πίνακα επιτυγχάνεται με τη χρήση διαφανών και γεμισμένων κελιών.
123+
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
124+
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)
130125

131126
## Μάθημα 6 - Δημιουργία συνδέσμων και μίξη στυλ κειμένου ##
132127

docs/Tutorial-he.md

+4-12
Original file line numberDiff line numberDiff line change
@@ -114,24 +114,16 @@ pdf.cell(60, 10, 'Powered by FPDF.', new_x="LMARGIN", new_y="NEXT", align='C')
114114

115115
## 5 - יצירת טבלאות ##
116116

117-
דוגמא זו מסבירה איך ליצור טבלאות בקלות.
118-
119-
הקוד ייצור שלוש טבלאות שונות על מנת להראות מה ניתן להשיג עם שינוים קלים.
120-
121117
```python
122118
{% include "../tutorial/tuto5.py" %}
123119
```
124120

125-
[תוצר](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
126-
[טקסט מתמשך](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
127-
128-
מאחר וטבלה היא בסה"כ אוסף של תאים, טבעי שכך נבנה טבלאות.
129-
130-
הדוגמא הראשונה נוצרת באופן הבסיסי ביותר שאפשר:תאים ממוסגרים, מיושרים לשמאל ובגדלים שווים. התוצאה היא בסיסית אבל קלה מאוד להשגה.
121+
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267
131122

132-
הטבלה השניה מציגה כמה שיפורים: לכל עמודה יש רוחב משלה, כותרות ממורכזות ותמונות מיושרות לימין. הוסרו קווים אופקיים. זה נעשה על ידי תכונות הגבול של המתודה Cell(), שמציינת איזה גבולות של התא להדפיס. כאן אנחנו רוצים את הגבול השמאלי (L) והימני (R). כעת נותרה הבעיה של הקווים האופקיים. ישנן שתי אפשרויות לפתור בעיה זו: לבדוק את הקו האחרון בלולאה, במקרה זה נשתמש בLRB עבור פרמטר הגבול; או לחלופין, כמו שעשינו כאן, להוסיף את הקו בסוף הלולאה.
123+
English versions:
133124

134-
הטבלה השלישית דומה לשניה אבל עושה שימוש בצבעים. צבעי המילוי, טקסט והקווים מצויינים במפורש. שינוי הצבעים נעשה על ידי שימוש בתאים שקופים ומלאים לסירוגין.
125+
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
126+
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)
135127

136128
## 6 - יצירת קישורים וערבוב סגנונות טקסט ##
137129

docs/Tutorial-it.md

+4-9
Original file line numberDiff line numberDiff line change
@@ -130,24 +130,19 @@ Una volta che il limite inferiore della terza colonna sarà raggiunto, [accept_p
130130

131131
## Tuto 5 - Creare tabelle ##
132132

133-
Questo tutoria spiegherà come creare facilmente tabelle.
134-
135-
Creeremo tre diverse tabelle per spiegare cosa si può ottenere con piccolo cambiamenti.
136-
137133
```python
138134
{% include "../tutorial/tuto5.py" %}
139135
```
140136

141137
[Risultato PDF](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
142138
[Testo delle nazioni](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
143139

144-
Dato che una tabella è un insieme di celle, viene natura crearne una partendo da loro.
145-
146-
Il primo esempio è la via più elementare: semplici celle con cornice, tutte della stessa dimensione e allineate a sinistra. Il risultato è rudimentale ma molto veloce da ottenere.
140+
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267
147141

148-
La seconda tabella contiene dei miglioramenti: ogni colonna ha la propria larghezza, i titoli sono centrati e i numeri allineati a destra. Inoltre, le linee orizzontale sono state rimosse. Questo è stato possibile grazie al parametro border del metodo Cell(), che specifica quali lati della cella saranno disegnati. In questo caso vogliamo il sinistro (L) e il destro (R). Rimane il problema delle linee orizzontali. Ci sono due possibilità per risolverlo: controllare di essere nell'ultimo giro del ciclo, nel qual caso utilizziamo LRB per il parametro border; oppure, come fatto in questo esempio, aggiungiamo una linea dopo il completamento del ciclo.
142+
English versions:
149143

150-
La terza tabella è molto simile alla seconda, ma utilizza i colori. Il colore di sfondo, testo e linee sono semplicemente specificati. L'alternanza dei colori delle righe è ottenuta utilizzando celle con sfondo colorato e trasparente alternativamente.
144+
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
145+
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)
151146

152147
## Tuto 6 - Creare link e mescolare stili di testo ##
153148

docs/Tutorial-pt.md

+4-12
Original file line numberDiff line numberDiff line change
@@ -125,27 +125,19 @@ Quando o limite inferior da terceira coluna é alcançado, o método [accept_pag
125125

126126
## Tuto 5 - Criar Tabelas ##
127127

128-
Este tutorial irá explicar como criar tabelas facilmente.
129-
130-
O código seguinte cria três tabelas diferentes para explicar o que pode ser alcançado com alguns ajustes simples.
131-
132128
```python
133129
{% include "../tutorial/tuto5.py"%}
134130
```
135131

136132
[PDF resultante](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
137133
[Texto dos países](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)
138134

139-
Uma vez que uma tabela é apenas uma coleção de células, é natural construir uma
140-
a partir delas.
141-
142-
O primeiro exemplo é obtido da maneira mais básica possível: moldura simples
143-
células, todas do mesmo tamanho e alinhadas à esquerda. O resultado é rudimentar, mas
144-
muito rápido de obter.
135+
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267
145136

146-
A segunda tabela traz algumas melhorias: cada coluna tem sua largura própria, os títulos estão centrados e as figuras alinhadas à direita. Além disso, as linhas horizontais foram removidas. Isto é feito por meio do parâmetro border do método Cell(), que especifica quais lados da célula devem ser desenhados. Aqui nós queremos os esquerdo (L) e direito (R). Agora apenas o problema da linha horizontal para terminar a mesa permanece. Existem duas possibilidades para resolvê-lo: verificar para a última linha do loop, caso este em que usamos LRB para o parâmetro da borda; ou, como foi feito aqui, adicione a linha assim que o loop terminar.
137+
English versions:
147138

148-
A terceira tabela é semelhante à segunda, mas usa cores. Preenchimento, texto e as cores das linhas são simplesmente especificadas. Coloração alternativa para linhas é obtida usando células alternativamente transparentes e preenchidas.
139+
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
140+
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)
149141

150142
## Tuto 6 - Criar links e misturar estilos de texto ##
151143

0 commit comments

Comments
 (0)