Updated documentation.

laurentmuller · Jan 15, 2025 · df2593e · df2593e
1 parent 9a86043
commit df2593e
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 116 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Updated documentation.
 - Added `PdfAttachmentTrait` trait.
 - Updated test for `PdfSectorTrait`.
 - Updated `PdfViewerPreferences` class.

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 This repository is clone of [fpdf.org](http://www.fpdf.org) with typed variables,
 enumerations and PHP 8.2 dependencies.
 
-`PdfDocument` is a PHP class, which allows to generate PDF files with pure PHP.
+`PdfDocument` is a PHP class, which allows generating PDF files with pure PHP.
 **F** from FPDF2 stands for **Free**: you may use it for any kind of usage and
 modify it to suit your needs.
 
@@ -19,8 +19,8 @@ composer require laurentmuller/fpdf2
 Alternatively, you can add the requirement `"laurentmuller/fpdf2":"^2.0"` to
 your `composer.json` file and run `composer update`. This could be useful when
 the installation of FPDF2 is not compatible with some currently installed
-dependencies. Anyway, the previous option is the preferred way, since composer
-can pick the best requirement constraint for you.
+dependencies. Anyway, the previous option is the preferred way, since the
+composer can pick the best requirement constraint for you.
 
 ## Basic Usage
 
@@ -36,19 +36,7 @@ $pdf->cell(40, 10, 'Hello World!');
 $pdf->output();
 ```
 
-## Tutorials
-
-- [Minimal example](doc/tuto_1.md)
-- [Header, footer, page break and image](doc/tuto_2.md)
-- [Line breaks and colors](doc/tuto_3.md)
-- [Multi-columns](doc/tuto_4.md)
-- [Tables](doc/tuto_5.md)
-- [Bookmarks](doc/tuto_6.md)
-- [Transparency](doc/tuto_7.md)
-- [Circles and ellipses](doc/tuto_8.md)
-- [Rotation](doc/tuto_9.md)
-- [Sector](doc/tuto_10.md)
-- [Attachments](doc/tuto_11.md)
+See other [examples](doc/examples.md) in the dedicated documents.
 
 ## Code Quality
 

diff --git a/doc/examples.md b/doc/examples.md
@@ -0,0 +1,19 @@
+# Examples
+
+Below is a list of examples:
+
+- [Minimal example](tuto_1.md)
+- [Header, footer, page break and image](tuto_2.md)
+- [Line breaks and colors](tuto_3.md)
+- [Multi-columns](tuto_4.md)
+- [Tables](tuto_5.md)
+- [Bookmarks](tuto_6.md)
+- [Transparency](tuto_7.md)
+- [Circles and ellipses](tuto_8.md)
+- [Rotation](tuto_9.md)
+- [Sector](tuto_10.md)
+- [Attachments](tuto_11.md)
+
+**See also:**
+
+[Home](../README.md)
diff --git a/doc/tuto_1.md b/doc/tuto_1.md
@@ -79,13 +79,5 @@ If you send something after, the document might not display.
 
 **See also:**
 
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_10.md b/doc/tuto_10.md
@@ -46,13 +46,5 @@ $pdf->output();
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_11.md b/doc/tuto_11.md
@@ -30,14 +30,5 @@ $pdf->output();
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_2.md b/doc/tuto_2.md
@@ -52,13 +52,5 @@ $pdf->output();
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_3.md b/doc/tuto_3.md
@@ -109,13 +109,5 @@ right-click and select Document Properties. The third method is to type the
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_4.md b/doc/tuto_4.md
@@ -118,13 +118,5 @@ $pdf->output();
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_5.md b/doc/tuto_5.md
@@ -143,13 +143,5 @@ using alternatively transparent and filled cells.
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_6.md b/doc/tuto_6.md
@@ -46,13 +46,5 @@ previous values.
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_7.md b/doc/tuto_7.md
@@ -36,13 +36,5 @@ $pdf->resetAlpha();
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Circles and ellipses](tuto_8.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_8.md b/doc/tuto_8.md
@@ -36,13 +36,5 @@ $pdf->ellipse(30, 245, 20, 10, PdfRectangleStyle::BOTH);
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Rotation](tuto_9.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)
diff --git a/doc/tuto_9.md b/doc/tuto_9.md
@@ -44,13 +44,5 @@ $pdf->endRotate();
 
 **See also:**
 
-- [Minimal example](tuto_1.md)
-- [Header, footer, page break and image](tuto_2.md)
-- [Line breaks and colors](tuto_3.md)
-- [Multi-columns](tuto_4.md)
-- [Tables](tuto_5.md)
-- [Bookmarks](tuto_6.md)
-- [Transparency](tuto_7.md)
-- [Circles and ellipses](tuto_8.md)
-- [Sector](tuto_10.md)
+- [Examples](examples.md)
 - [Home](../README.md)