Skip to content

Commit eac8be0

Browse files
committed
Minor documentation improvements
1 parent a9c3623 commit eac8be0

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

docs/Text.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ There are several ways in fpdf to add text to a PDF document, each of which come
44

55
## Simple Text Methods
66

7-
| method | lines | markdown support | HTML support | text shaping | accepts new current position | details |
8-
| -- | :--: | :--: | :--: | :--: | :--: |-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
9-
| [`.text()`](#text) | one | no | no | no | fixed | Inserts a single-line text string with a precise location on the base line of the font. |
10-
| [`.cell()`](#cell) | one | yes | no | yes | yes | Inserts a single-line text string within the boundaries of a given box, optionally with background and border. |
11-
| [`.multi_cell()`](#multi_cell) | several | yes | no | yes | yes | Inserts a multi-line text string within the boundaries of a given box, optionally with background, border and padding. |
12-
| [`.write()`](#write) | several | no | no | yes | auto | Inserts a multi-line text string within the boundaries of the page margins, starting at the current x/y location (typically the end of the last inserted text). |
13-
| [`.write_html()`](#write_html) | several | no | yes | yes | auto | An extension to `.write()`, with additional parsing of basic HTML tags.
7+
| Method | Lines | [Markdown](TextStyling.md#markdowntrue) & [HTML](HTML.md) support | Supports [text shaping](TextShaping.md) | Details
8+
| -- | :--: | :--: | :--: |-
9+
| [`.text()`](#text) | one | none | no | Inserts a single-line text string with a precise location on the base line of the font.
10+
| [`.cell()`](#cell) | one | Markdown | yes | Inserts a single-line text string within the boundaries of a given box, optionally with background and border.
11+
| [`.multi_cell()`](#multi_cell) | several | Markdown | yes | Inserts a multi-line text string within the boundaries of a given box, optionally with background, border and padding.
12+
| [`.write()`](#write) | several | none | yes | Inserts a multi-line text string within the boundaries of the page margins, starting at the current x/y location (typically the end of the last inserted text).
13+
| [`.write_html()`](#write_html) | several | HTML | yes | auto | An extension to `.write()`, with additional parsing of basic HTML tags.
1414

1515
## Flowable Text Regions
1616

@@ -19,14 +19,16 @@ The currently implemented type of text regions is [text_columns()](TextColumns.h
1919

2020
## Typography and Language Specific Concepts
2121
### Supported Features
22-
With supporting Unicode fonts, fpdf2 should handle the following text shaping features correctly. More details can be found in [TextShaping](TextShaping.html).
22+
With supporting Unicode fonts, `fpdf2` should handle the following text shaping features correctly. More details can be found in [TextShaping](TextShaping.md).
23+
2324
* Automatic ligatures / glyph substitution - Some writing systems (eg. most Indic scripts such as Devaganari, Tamil, Kannada) frequently combine a number of written characters into a single glyph. In latin script, "ff", "fi", "ft", "st" and others are often combined. In programming fonts "<=", "++" "!=" etc. may be combined into more compact representations.
2425
* Special diacritics that use separate code points (eg. in Diné Bizaad, Hebrew) will be placed in the correct location relative to their base character.
2526
* Kerning, where the spacing between characters varies depending on their combination (eg. moving the succeeding lowercase character closer to an uppercase "T".
2627
* Left-to-right and right-to-left text formatting (the latter most prominently in Arabic and Hebrew).
2728

2829
### Limitations
29-
There are a few advanced typesetting features that fpdf doesn't currently support.
30+
There are a few advanced typesetting features that `fpdf2` doesn't currently support:
31+
3032
* Contextual forms - In some writing systems (eg. Arabic, Mongolian, etc.), characters may take a different shape, depending on whether they appear at the beginning, in the middle, or at the end of a word, or isolated. Fpdf will always use the same standard shape in those cases.
3133
* Vertical writing - Some writing systems are meant to be written vertically. Doing so is not directly supported. In cases where this just means to stack characters on top of each other (eg. Chinese, Japanese, etc.), client software can implement this by placing each character individuall at the correct location. In cases where the characters are connected with each other (eg. Mongolian), this may be more difficult, if possible at all.
3234

docs/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ Online classes & open source projects:
136136

137137
## Misc ##
138138

139-
* Release notes: [CHANGELOG.md](https://github.com/py-pdf/fpdf2/blob/master/CHANGELOG.md)
139+
* Release notes for every versions of `fpdf2`: [CHANGELOG.md](https://github.com/py-pdf/fpdf2/blob/master/CHANGELOG.md)
140+
* Project history: [History](History.md)
140141
* This library could only exist thanks to the dedication of many volunteers around the world:
141142
[list & map of contributors](https://github.com/py-pdf/fpdf2/blob/master/README.md#contributors-)
142143
* You can download an offline PDF version of this manual: [fpdf2-manual.pdf](fpdf2-manual.pdf)

0 commit comments

Comments
 (0)