Skip to content

Commit

Permalink
Tutorial update
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucas-C committed Feb 24, 2023
1 parent 4cfa1bb commit aaac62f
Show file tree
Hide file tree
Showing 25 changed files with 99 additions and 869 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/continuous-integration-workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ jobs:
sed -i "s/author:.*/author: v$(python setup.py -V 2>/dev/null)/" mkdocs.yml
cp tutorial/notebook.ipynb docs/
mkdocs build
pdoc --html -o public/ fpdf
pdoc --html -o public/ fpdf --config "git_link_template='https://github
.com/PyFPDF/fpdf2/blob/{commit}/{path}#L{start_line}-L{end_line}'"
cd contributors/ && PYTHONUNBUFFERED=1 ./build_contributors_html_page.py PyFPDF/fpdf2
cp -t ../public/ contributors.html contributors-map-small.png
- name: Deploy documentation 🚀
Expand Down
2 changes: 2 additions & 0 deletions docs/Tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ Result:

![](table_with_single_top_line_layout.jpg)

All the possible layout values are described there: [`TableBordersLayout`](https://pyfpdf.github.io/fpdf2/fpdf/enums.html#fpdf.enums.TableBordersLayout).

## Insert images
```python
TABLE_DATA = (
Expand Down
18 changes: 4 additions & 14 deletions docs/Tutorial-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,29 +144,19 @@ Sobald det Text der dritten den oben beschriebenen Abstand zum Seitenende erreic

## Lektion 5 - Tabellen erstellen ##

In dieser Lektion zeigen wir, wie man auf einfache Weise Tabellen erstellen kann.

Der Code wird drei verschiedene Tabellen erstellen, um zu zeigen, welche Effekte wir mit einigen einfachen Anpassungen erzielen können.

```python
{% include "../tutorial/tuto5.py" %}
```

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

Da eine Tabelle lediglich eine Sammlung von Zellen darstellt, ist es naheliegend, eine Tabelle aus den bereits bekannten Zellen aufzubauen.

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.
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267

Die zweite Tabelle bringt einige Verbesserungen: Jede Spalte hat ihre eigene Breite,
die Überschriften sind zentriert und die Zahlen rechtsbündig ausgerichtet. Außerdem wurden die horizontalen Linien
entfernt. Dies geschieht mit Hilfe des Randparameters der Methode `cell()`, der angibt, welche Seiten der Zelle gezeichnet werden müssen.
Im Beispiel wählen wir die linke (L) und die rechte (R) Seite. Jetzt muss nur noch das Problem der horizontalen Linie
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.
English versions:

Die dritte Tabelle der zweiten sehr ähnlich, verwendet aber zusätzlich Farben. Füllung, Text und
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.
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)

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

Expand Down
30 changes: 6 additions & 24 deletions docs/Tutorial-es.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,37 +169,19 @@ volverá a la primera columna, desencadenando un salto de página.

## Tutorial 5 - Creando tablas ##

Este tutorial explicará cómo crear tablas fácilmente.

El código creará tres tablas diferentes para explicar lo que
puede lograrse con algunos cambios sencillos.

```python
{% include "../tutorial/tuto5.py" %}
```

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

Dado que una tabla es solo una colección de celdas, es natural construir una
a partir de ellas.

El primer ejemplo se logra de la forma más básica posible: simples celdas
enmarcadas, todas del mismo tamaño y alineadas a la izquierda. El resultado es rudimentario pero
muy rápido de obtener.

La segunda tabla incluye algunas mejoras: cada columna tiene su propio ancho,
los títulos están centrados y las figuras alineadas a la derecha. Es más, las líneas horizontales han
sido removidas. Esto es hecho por medio del parámetro `border` del método
`Cell()`, el cual especifica qué lados de la celda deben dibujarse. Aquí queremos
el izquierdo (`L`) y el derecho (`R`). Ahora solo queda el problema de la línea horizontal
para terminar la tabla. Hay dos posibilidades para resolverlo: encontrar
la última línea en el ciclo, en cuyo caso usamos LRB para el parámetro
`border`; o, como se hizo aquí, agregar la línea una vez el ciclo ha terminado.

La tercera tabla es similar a la segunda, pero usa colores. Los colores de relleno,
texto y línea son especificados de manera simple. Un coloreado alternante para las filas es obtenido
usando de forma alternada celdas transparentes y rellenas.
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267

English versions:

* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)

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

Expand Down
17 changes: 7 additions & 10 deletions docs/Tutorial-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,24 +110,21 @@ En utilisant la méthode [accept_page_break](fpdf/fpdf.html#fpdf.fpdf.FPDF.accep
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.

## Tuto 5 - Créer des tables ##
Ce tutoriel explique comment créer facilement des tableaux.

Le code créera trois tableaux différents pour expliquer ce qui peut être réalisé avec quelques modifications.
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.

```python
{% include "../tutorial/tuto5.py" %}
```

[PDF généré](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
[Liste de pays](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)

Comme un tableau n'est qu'une collection de cellules, il est naturel d'en construire un à partir de celles-ci.

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.
[Données CSV des pays](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)

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.
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.

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.
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...
De plus, les lignes horizontales ont été supprimées.
Cela grâce à la sélection d'un `table.borders_layout` parmi les valeurs disponibles :
[`TableBordersLayout`](https://pyfpdf.github.io/fpdf2/fpdf/enums.html#fpdf.enums.TableBordersLayout).

## Tuto 6 - Créer des liens et mélanger différents styles de textes ##
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.
Expand Down
13 changes: 4 additions & 9 deletions docs/Tutorial-gr.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,24 +109,19 @@ pdf.cell(60, 10, 'Powered by FPDF.', new_x="LMARGIN", new_y="NEXT", align='C')

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

Σε αυτό το μάθημα θα εξηγήσουμε πως να δημιουργούμε εύκολα πίνακες.

Ο κώδικας θα δημιουργήσει τρεις διαφορετικούς πίνακες έτσι ώστε να παρουσιάσουμε τι μπορεί να επιτευχθεί με μερικές απλές προσαρμογές.

```python
{% include "../tutorial/tuto5.py" %}
```

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

Εφόσον ένας πίνακας αποτελεί μία συλλογή από κελιά, είναι φυσικό να τον κατασκευάσουμε από αυτά.

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

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

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

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

Expand Down
16 changes: 4 additions & 12 deletions docs/Tutorial-he.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,24 +114,16 @@ pdf.cell(60, 10, 'Powered by FPDF.', new_x="LMARGIN", new_y="NEXT", align='C')

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

דוגמא זו מסבירה איך ליצור טבלאות בקלות.

הקוד ייצור שלוש טבלאות שונות על מנת להראות מה ניתן להשיג עם שינוים קלים.

```python
{% include "../tutorial/tuto5.py" %}
```

[תוצר](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/tuto5.pdf) -
[טקסט מתמשך](https://github.com/PyFPDF/fpdf2/raw/master/tutorial/countries.txt)

מאחר וטבלה היא בסה"כ אוסף של תאים, טבעי שכך נבנה טבלאות.

הדוגמא הראשונה נוצרת באופן הבסיסי ביותר שאפשר:תאים ממוסגרים, מיושרים לשמאל ובגדלים שווים. התוצאה היא בסיסית אבל קלה מאוד להשגה.
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267

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

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

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

Expand Down
13 changes: 4 additions & 9 deletions docs/Tutorial-it.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,24 +130,19 @@ Una volta che il limite inferiore della terza colonna sarà raggiunto, [accept_p

## Tuto 5 - Creare tabelle ##

Questo tutoria spiegherà come creare facilmente tabelle.

Creeremo tre diverse tabelle per spiegare cosa si può ottenere con piccolo cambiamenti.

```python
{% include "../tutorial/tuto5.py" %}
```

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

Dato che una tabella è un insieme di celle, viene natura crearne una partendo da loro.

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.
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267

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.
English versions:

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.
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)

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

Expand Down
16 changes: 4 additions & 12 deletions docs/Tutorial-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,27 +125,19 @@ Quando o limite inferior da terceira coluna é alcançado, o método [accept_pag

## Tuto 5 - Criar Tabelas ##

Este tutorial irá explicar como criar tabelas facilmente.

O código seguinte cria três tabelas diferentes para explicar o que pode ser alcançado com alguns ajustes simples.

```python
{% include "../tutorial/tuto5.py"%}
```

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

Uma vez que uma tabela é apenas uma coleção de células, é natural construir uma
a partir delas.

O primeiro exemplo é obtido da maneira mais básica possível: moldura simples
células, todas do mesmo tamanho e alinhadas à esquerda. O resultado é rudimentar, mas
muito rápido de obter.
This section has changed a lot and requires a new translation: https://github.com/PyFPDF/fpdf2/issues/267

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.
English versions:

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.
* [Tuto 5 - Creating Tables](https://pyfpdf.github.io/fpdf2/Tutorial.html#tuto-5-creating-tables)
* [Documentation on tables](https://pyfpdf.github.io/fpdf2/Tables.html)

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

Expand Down
Loading

0 comments on commit aaac62f

Please sign in to comment.