diff --git a/docs/FAQ.md b/docs/FAQ.md index 7960a4caa..ced7c5be2 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -31,7 +31,7 @@ This library is not a: columns, chapters, etc., see [Tutorial](Tutorial.md)) * XML /object definition language like [Geraldo Reports](http://www.geraldoreports.org/), Jasper Reports or similar - (look at [write_html](reference/WriteHTML.md) for simple HTML reports and + (look at [write_html](reference/write_html.md) for simple HTML reports and [Templates](Templates.md) for fill-in-the-blank documents) * PDF text extractor/conversor, spltiter or similar. Look at [pyPdf](https://pypi.python.org/pypi/pyPdf) diff --git a/docs/ReferenceManual.md b/docs/ReferenceManual.md index 0fab025ce..80b9934be 100644 --- a/docs/ReferenceManual.md +++ b/docs/ReferenceManual.md @@ -6,59 +6,59 @@ **Important**: original FPDF (PHP) naming convention is CamelCase. This library uses [PEP8](http://www.python.org/dev/peps/pep-0008/) lower\_case\_with\_underscores recommendation. - * [accept_page_break](reference/AcceptPageBreak.md) - accept or not automatic page break - * [add_font](reference/AddFont.md) - add a new font - * [add_link](reference/AddLink.md) - create an internal link - * [add_page](reference/AddPage.md) - add a new page - * [alias_nb_pages](reference/AliasNbPages.md) - define an alias for number of pages - * [cell](reference/Cell.md) - print a cell - * [close](reference/Close.md) - terminate the document - * [error](reference/Error.md) - fatal error - * [footer](reference/Footer.md) - page footer + * [accept_page_break](reference/accept_page_break.md) - accept or not automatic page break + * [add_font](reference/add_font.md) - add a new font + * [add_link](reference/add_link.md) - create an internal link + * [add_page](reference/add_page.md) - add a new page + * [alias_nb_pages](reference/alias_nb_pages.md) - define an alias for number of pages + * [cell](reference/cell.md) - print a cell + * [close](reference/close.md) - terminate the document + * [error](reference/error.md) - fatal error + * [footer](reference/footer.md) - page footer * [FPDF](reference/FPDF.md) - constructor - * [get_string_width](reference/GetStringWidth.md) - compute string length - * [get_x](reference/GetX.md) - get current x position - * [get_y](reference/GetY.md) - get current y position - * [header](reference/Header.md) - page header - * [image](reference/Image.md) - output an image - * [line](reference/Line.md) - draw a line - * [link](reference/Link.md) - put a link - * [ln](reference/Ln.md) - line break - * [multi_cell](reference/MultiCell.md) - print text with line breaks - * [output](reference/Output.md) - save or send the document - * [page_no](reference/PageNo.md) - page number - * [rect](reference/Rect.md) - draw a rectangle - * [set_author](reference/SetAuthor.md) - set the document author - * [set_auto_page_break](reference/SetAutoPageBreak.md) - set the automatic page breaking mode - * [set_compression](reference/SetCompression.md) - turn compression on or off - * [set_creator](reference/SetCreator.md) - set document creator - * [set_display_mode](reference/SetDisplayMode.md) - set display mode - * [set_draw_color](reference/SetDrawColor.md) - set drawing color - * [set_fill_color](reference/SetFillColor.md) - set filling color - * [set_font](reference/SetFont.md) - set font - * [set_font_size](reference/SetFontSize.md) - set font size - * [set_keywords](reference/SetKeywords.md) - associate keywords with document - * [set_left_margin](reference/SetLeftMargin.md) - set left margin - * [set_line_width](reference/SetLineWidth.md) - set line width - * [set_link](reference/SetLink.md) - set internal link destination - * [set_margins](reference/SetMargins.md) - set margins - * [set_right_margin](reference/SetRightMargin.md) - set right margin - * [set_subject](reference/SetSubject.md) - set document subject - * [set_text_color](reference/SetTextColor.md) - set text color - * [set_title](reference/SetTitle.md) - set document title - * [set_top_margin](reference/SetTopMargin.md) - set top margin - * [set_x](reference/SetX.md) - set current x position - * [set_xy](reference/SetXY.md) - set current x and y positions - * [set_y](reference/SetY.md) - set current y position - * [text](reference/Text.md) - print a string - * [write](reference/Write.md) - print flowing text + * [get_string_width](reference/get_string_width.md) - compute string length + * [get_x](reference/get_x.md) - get current x position + * [get_y](reference/get_y.md) - get current y position + * [header](reference/header.md) - page header + * [image](reference/image.md) - output an image + * [line](reference/line.md) - draw a line + * [link](reference/link.md) - put a link + * [ln](reference/ln.md) - line break + * [multi_cell](reference/multi_cell.md) - print text with line breaks + * [output](reference/output.md) - save or send the document + * [page_no](reference/page_no.md) - page number + * [rect](reference/rect.md) - draw a rectangle + * [set_author](reference/set_author.md) - set the document author + * [set_auto_page_break](reference/set_auto_page_break.md) - set the automatic page breaking mode + * [set_compression](reference/set_compression.md) - turn compression on or off + * [set_creator](reference/set_creator.md) - set document creator + * [set_display_mode](reference/set_display_mode.md) - set display mode + * [set_draw_color](reference/set_draw_color.md) - set drawing color + * [set_fill_color](reference/set_fill_color.md) - set filling color + * [set_font](reference/set_font.md) - set font + * [set_font_size](reference/set_font_size.md) - set font size + * [set_keywords](reference/set_keywords.md) - associate keywords with document + * [set_left_margin](reference/set_left_margin.md) - set left margin + * [set_line_width](reference/set_line_width.md) - set line width + * [set_link](reference/set_link.md) - set internal link destination + * [set_margins](reference/set_margins.md) - set margins + * [set_right_margin](reference/set_right_margin.md) - set right margin + * [set_subject](reference/set_subject.md) - set document subject + * [set_text_color](reference/set_text_color.md) - set text color + * [set_title](reference/set_title.md) - set document title + * [set_top_margin](reference/set_top_margin.md) - set top margin + * [set_x](reference/set_x.md) - set current x position + * [set_xy](reference/set_xy.md) - set current x and y positions + * [set_y](reference/set_y.md) - set current y position + * [text](reference/text.md) - print a string + * [write](reference/write.md) - print flowing text ## Additional API ## This features not available in original FPDF and implemented after fork. - * [dashed_line](reference/DashedLine.md) - draw a dashed line - * [ellipse](reference/Ellipse.md) - draw an ellipse - * [set_stretching](reference/SetStretching.md) - set horizontal font stretching - * [write_html](reference/WriteHTML.md) - print text with HTML markup + * [dashed_line](reference/dashed_line.md) - draw a dashed line + * [ellipse](reference/ellipse.md) - draw an ellipse + * [set_stretching](reference/set_stretching.md) - set horizontal font stretching + * [write_html](reference/write_html.md) - print text with HTML markup diff --git a/docs/Tutorial-es.md b/docs/Tutorial-es.md index 229384fb1..f9fdeaef4 100644 --- a/docs/Tutorial-es.md +++ b/docs/Tutorial-es.md @@ -28,9 +28,9 @@ pdf=FPDF('P', 'mm', 'A4') Es posible usar landscape -apaisado- (L), otros formatos de página (como Letter -carta- y Legal -oficio-) y únidad de medida (pt, cm, in). -Por el momento no hay una página, entonces tenemos que agregar una con [add_page](reference/AddPage.md). El origen es la esquina superior-izquierda y la posición actual está ubicada a 1 cm de los bordes; los margenes pueden ser cambiados con [set_margins](reference/SetMargins.md). +Por el momento no hay una página, entonces tenemos que agregar una con [add_page](reference/add_page.md). El origen es la esquina superior-izquierda y la posición actual está ubicada a 1 cm de los bordes; los margenes pueden ser cambiados con [set_margins](reference/set_margins.md). -Antes de que podámos imprimir texto, es obligatorio seleccionar una fuente con [set_font](reference/SetFont.md), de lo contrario el documento será inválido. Elegimos Arial bold 16: +Antes de que podámos imprimir texto, es obligatorio seleccionar una fuente con [set_font](reference/set_font.md), de lo contrario el documento será inválido. Elegimos Arial bold 16: ```python pdf.set_font('Arial', 'B', 16) @@ -38,7 +38,7 @@ pdf.set_font('Arial', 'B', 16) Podríamos haber especificado italic -cursiva- con I, underline -subrayado- con U o fuente regular con string vacio (o cualquier combinación). Noar que el tamaño de la fuente es dado en puntos, no milimetros (u otra unidad de medida del usuario); esta es la única excepción. Las otras fuentes estándar son Times, Courier, Symbol y ZapfDingbats. -Podemos ahora imprimir una celda con [cell](reference/Cell.md). Una celda es un área rectangular, posiblemente enmarcada, que contiene algún texto. Se imprime en la posición actual. Especificamos sus dimensiones, su texto (centrado o alineado), si los bordes deberían ser dibujados, y donde la posición actual se mueve después (a la derecha, abajo o al principio de la próxima linea). Para agregar un marco, haremos: +Podemos ahora imprimir una celda con [cell](reference/cell.md). Una celda es un área rectangular, posiblemente enmarcada, que contiene algún texto. Se imprime en la posición actual. Especificamos sus dimensiones, su texto (centrado o alineado), si los bordes deberían ser dibujados, y donde la posición actual se mueve después (a la derecha, abajo o al principio de la próxima linea). Para agregar un marco, haremos: ```python pdf.cell(40, 10, 'Hola mundo !', 1) @@ -50,9 +50,9 @@ Para agregar una nueva celda próxima a ella con texto centrada y luego ir a la pdf.cell(60, 10, 'Hecho con FPDF.', 0, 1, 'C') ``` -*Nota*: el salto de línea puede hacerse también con [ln](reference/Ln.md). Este método permite especificar adicionalmente la altura del salto. +*Nota*: el salto de línea puede hacerse también con [ln](reference/ln.md). Este método permite especificar adicionalmente la altura del salto. -Finalmente, el documento es cerrado y enviado al explorador con [output](reference/Output.md). Podemos haberlo grabado a un fichero al pasarle el nombre de archivo. +Finalmente, el documento es cerrado y enviado al explorador con [output](reference/output.md). Podemos haberlo grabado a un fichero al pasarle el nombre de archivo. *Precaución*: en caso cuando el PDF es enviado al explorador, nada más debe ser enviádo a la salida, ni antes ni después (el mínimo caracter importa). @@ -97,14 +97,14 @@ pdf.output('tuto2.pdf', 'F') ``` [Demo](http://pyfpdf.googlecode.com/hg/tutorial/tuto2.pdf) -Este ejemplo hace uso de métodos [header](reference/Header.md) y [footer](reference/Footer.md) para procesar el encabezado y pie. Son llamados automáticamente. Ya existen en la clase FPDF pero no hacen nada, por lo tanto tenemos que extender la clase y sobreescribirlos. +Este ejemplo hace uso de métodos [header](reference/header.md) y [footer](reference/footer.md) para procesar el encabezado y pie. Son llamados automáticamente. Ya existen en la clase FPDF pero no hacen nada, por lo tanto tenemos que extender la clase y sobreescribirlos. -El log es impreso con el método [image](reference/Image.md) especificando su esquina superior izquierda y su ancho. La altura es calculada automáticamente para respetar las proporciones de la imágen. +El log es impreso con el método [image](reference/image.md) especificando su esquina superior izquierda y su ancho. La altura es calculada automáticamente para respetar las proporciones de la imágen. -Para imprimir el número de página, un valor nulo es pasado como ancho de celda. Significa que la celda deberá ser extendida hasta el margen derecho de la página; es útil centrar texto. El número de página actual es devuelto por el método [page_no](reference/PageNo.md); y para el número total de páginas, será obtenido mediante el valor especial {nb} que será sustituido al cerrar el documento (si de antemano se llamó [alias_nb_pages](reference/AliasNbPages.md)). -Notar el uso del método [set_y](reference/SetY.md) que permite establecer la posición en una ubicación absoluta en la página, empezando desde arriba hacia abajo. +Para imprimir el número de página, un valor nulo es pasado como ancho de celda. Significa que la celda deberá ser extendida hasta el margen derecho de la página; es útil centrar texto. El número de página actual es devuelto por el método [page_no](reference/page_no.md); y para el número total de páginas, será obtenido mediante el valor especial {nb} que será sustituido al cerrar el documento (si de antemano se llamó [alias_nb_pages](reference/alias_nb_pages.md)). +Notar el uso del método [set_y](reference/set_y.md) que permite establecer la posición en una ubicación absoluta en la página, empezando desde arriba hacia abajo. -Otra característica interesante es usada aquí: el salto de página automático. Tan pronto una celda cruza el límite de una página (por defecto a 2 centimetros desde abajo), un salto es realizado y la fuente es restaurada. Aunque el encabezado y pie de página tienen su propia fuente (Arial), el cuerpo continua en Times. Este mecanismo de restauración automática tambien se aplica a los colores y el ancho de la línea. El límite que dispara los saltos de página puede establecerce con [set_auto_page_break](reference/SetAutoPageBreak.md). +Otra característica interesante es usada aquí: el salto de página automático. Tan pronto una celda cruza el límite de una página (por defecto a 2 centimetros desde abajo), un salto es realizado y la fuente es restaurada. Aunque el encabezado y pie de página tienen su propia fuente (Arial), el cuerpo continua en Times. Este mecanismo de restauración automática tambien se aplica a los colores y el ancho de la línea. El límite que dispara los saltos de página puede establecerce con [set_auto_page_break](reference/set_auto_page_break.md). ## Saltos de línea y colores ## @@ -181,11 +181,11 @@ pdf.output('tuto3.pdf', 'F') ``` [Demo](http://pyfpdf.googlecode.com/hg/tutorial/tuto3.pdf) -El método [get_string_width](reference/GetStringWidth.md) permite determinar la longitud de una cadena en la fuente actual, usado aquí para calcular la posición y el ancho del marco que rodea al título. Los colores son establecidos (vía [set_draw_color](reference/SetDrawColor.md), [set_fill_color](reference/SetFillColor.md) y [set_text_color](reference/SetTextColor.md)) y el grosor de la línea es establecido a 1 mm (contra 0.2 por defecto) con [set_line_width](reference/SetLineWidth.md). Finalmente, emitimos la celda (el último parámetro es True para indicar que el fondo debe ser rellenado). +El método [get_string_width](reference/get_string_width.md) permite determinar la longitud de una cadena en la fuente actual, usado aquí para calcular la posición y el ancho del marco que rodea al título. Los colores son establecidos (vía [set_draw_color](reference/set_draw_color.md), [set_fill_color](reference/set_fill_color.md) y [set_text_color](reference/set_text_color.md)) y el grosor de la línea es establecido a 1 mm (contra 0.2 por defecto) con [set_line_width](reference/set_line_width.md). Finalmente, emitimos la celda (el último parámetro es True para indicar que el fondo debe ser rellenado). -El método usado para imprimir parrafos es [multi_cell](reference/MultiCell.md). Cada vez que una línea alcanza el extremo derecho de la celda o un caracter de retorno de linea, un salto de línea es emitido y una nueva celda es automáticamente creada bajo la actual. El texto es justificado por defecto. +El método usado para imprimir parrafos es [multi_cell](reference/multi_cell.md). Cada vez que una línea alcanza el extremo derecho de la celda o un caracter de retorno de linea, un salto de línea es emitido y una nueva celda es automáticamente creada bajo la actual. El texto es justificado por defecto. -Dos propiedades del documento son definidas: el título ([set_title](reference/SetTitle.md)) y el autor ([set_author](reference/SetAuthor.md)). Las propiedades pueden ser vistas de dos formas. La primera es abrir el documento directamente con Acrobat Reader, ir al menú Archivo y elegir la opción Propiedades del Documento. La segunda, también disponible en el plug-in, es hacer click izquierdo y seleccionar Propiedades del documento (Document Properties). +Dos propiedades del documento son definidas: el título ([set_title](reference/set_title.md)) y el autor ([set_author](reference/set_author.md)). Las propiedades pueden ser vistas de dos formas. La primera es abrir el documento directamente con Acrobat Reader, ir al menú Archivo y elegir la opción Propiedades del Documento. La segunda, también disponible en el plug-in, es hacer click izquierdo y seleccionar Propiedades del documento (Document Properties). ## Notas de instalación ## diff --git a/docs/Tutorial.md b/docs/Tutorial.md index 2dd769a7f..710072866 100644 --- a/docs/Tutorial.md +++ b/docs/Tutorial.md @@ -33,12 +33,12 @@ It is possible to use landscape (`L`), other page formats (such as `Letter` and `Legal`) and measure units (`pt`, `cm`, `in`). There is no page for the moment, so we have to add one with -[add_page](reference/AddPage.md). The origin is at the upper-left corner and the +[add_page](reference/add_page.md). The origin is at the upper-left corner and the current position is by default placed at 1 cm from the borders; the margins can -be changed with [set_margins](reference/SetMargins.md). +be changed with [set_margins](reference/set_margins.md). Before we can print text, it is mandatory to select a font with -[set_font](reference/SetFont.md), otherwise the document would be invalid. We +[set_font](reference/set_font.md), otherwise the document would be invalid. We choose Arial bold 16: ```python @@ -50,7 +50,7 @@ with an empty string (or any combination). Note that the font size is given in points, not millimeters (or another user unit); it is the only exception. The other standard fonts are `Times`, `Courier`, `Symbol` and `ZapfDingbats`. -We can now print a cell with [cell](reference/Cell.md). A cell is a rectangular +We can now print a cell with [cell](reference/cell.md). A cell is a rectangular area, possibly framed, which contains some text. It is output at the current position. We specify its dimensions, its text (centered or aligned), if borders should be drawn, and where the current position moves after it (to the right, @@ -67,11 +67,11 @@ would do: pdf.cell(60, 10, 'Powered by FPDF.', 0, 1, 'C') ``` -**Remark**: the line break can also be done with [ln](reference/Ln.md). This +**Remark**: the line break can also be done with [ln](reference/ln.md). This method allows to specify in addition the height of the break. Finally, the document is closed and sent to the browser with -[output](reference/Output.md). We could have saved it in a file by passing the +[output](reference/output.md). We could have saved it in a file by passing the desired file name. **Caution**: in case when the PDF is sent to the browser, nothing else must be @@ -121,23 +121,23 @@ pdf.output('tuto2.pdf', 'F') [Demo](http://pyfpdf.googlecode.com/hg/tutorial/tuto2.pdf) -This example makes use of the [header](reference/Header.md) and -[footer](reference/Footer.md) methods to process page headers and footers. They +This example makes use of the [header](reference/header.md) and +[footer](reference/footer.md) methods to process page headers and footers. They are called automatically. They already exist in the FPDF class but do nothing, therefore we have to extend the class and override them. -The logo is printed with the [image](reference/Image.md) method by specifying +The logo is printed with the [image](reference/image.md) method by specifying its upper-left corner and its width. The height is calculated automatically to respect the image proportions. To print the page number, a null value is passed as the cell width. It means that the cell should extend up to the right margin of the page; it is handy to center text. The current page number is returned by -the [page_no](reference/PageNo.md) method; as for +the [page_no](reference/page_no.md) method; as for the total number of pages, it is obtained by means of the special value `{nb}` which will be substituted on document closure (provided you first called -[alias_nb_pages](reference/AliasNbPages.md)). -Note the use of the [set_y](reference/SetY.md) method which allows to set +[alias_nb_pages](reference/alias_nb_pages.md)). +Note the use of the [set_y](reference/set_y.md) method which allows to set position at an absolute location in the page, starting from the top or the bottom. @@ -147,7 +147,7 @@ default), a break is performed and the font restored. Although the header and footer select their own font (`Arial`), the body continues with `Times`. This mechanism of automatic restoration also applies to colors and line width. The limit which triggers page breaks can be set with -[set_auto_page_break](reference/SetAutoPageBreak.md). +[set_auto_page_break](reference/set_auto_page_break.md). ## Line breaks and colors ## @@ -227,24 +227,24 @@ pdf.output('tuto3.pdf', 'F') [Demo](http://pyfpdf.googlecode.com/hg/tutorial/tuto3.pdf) -The [get_string_width](reference/GetStringWidth.md) method allows to determine +The [get_string_width](reference/get_string_width.md) method allows to determine the length of a string in the current font, which is used here to calculate the position and the width of the frame surrounding the title. Then colors are set -(via [set_draw_color](reference/SetDrawColor.md), -[set_fill_color](reference/SetFillColor.md) and -[set_text_color](reference/SetTextColor.md)) and the thickness of the line is set +(via [set_draw_color](reference/set_draw_color.md), +[set_fill_color](reference/set_fill_color.md) and +[set_text_color](reference/set_text_color.md)) and the thickness of the line is set to 1 mm (against 0.2 by default) with -[set_line_width](reference/SetLineWidth.md). Finally, we output the cell (the +[set_line_width](reference/set_line_width.md). Finally, we output the cell (the last parameter to true indicates that the background must be filled). -The method used to print the paragraphs is [multi_cell](reference/MultiCell.md). +The method used to print the paragraphs is [multi_cell](reference/multi_cell.md). Each time a line reaches the right extremity of the cell or a carriage return character is met, a line break is issued and a new cell automatically created under the current one. Text is justified by default. Two document properties are defined: the title -([set_title](reference/SetTitle.md)) and the author -([set_author](reference/SetAuthor.md)). Properties can be viewed by two means. +([set_title](reference/set_title.md)) and the author +([set_author](reference/set_author.md)). Properties can be viewed by two means. First is to open the document directly with Acrobat Reader, go to the File menu and choose the Document Properties option. The second, also available from the plug-in, is to right-click and select Document Properties. diff --git a/docs/Unicode.md b/docs/Unicode.md index 576fffdb2..0816a4a3b 100644 --- a/docs/Unicode.md +++ b/docs/Unicode.md @@ -35,7 +35,7 @@ These fonts are included with this library installers, see more information. Then, to use a Unicode font in your script, pass `True` as the fourth parameter -of [add_font](reference/AddFont.md). +of [add_font](reference/add_font.md). ## Example ## diff --git a/docs/Web2Py.md b/docs/Web2Py.md index 646ecf87d..b330f8b88 100644 --- a/docs/Web2Py.md +++ b/docs/Web2Py.md @@ -2,7 +2,7 @@ # Introduction # -If you use [web2py](http://www.web2py.com), you can make complex reports that can be viewed in a browser, or downloaded as PDF (taking advantage of web2py HTML helper objects to easily diagram a report). See [write_html](reference/WriteHTML.md) for more information, supported tags and attributes, etc. +If you use [web2py](http://www.web2py.com), you can make complex reports that can be viewed in a browser, or downloaded as PDF (taking advantage of web2py HTML helper objects to easily diagram a report). See [write_html](reference/write_html.md) for more information, supported tags and attributes, etc. Also, using web2py DAL, you can easily set up a templating engine for PDF documents. See [Templates](Templates.md) for more information. diff --git a/docs/reference/AddLink.md b/docs/reference/AddLink.md deleted file mode 100644 index de408b2fc..000000000 --- a/docs/reference/AddLink.md +++ /dev/null @@ -1,14 +0,0 @@ -## add_link ## - -```python -fpdf.add_link() -``` - -### Description ### - -Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document. -The identifier can then be passed to [cell](Cell.md), [write](Write.md), [image](Image.md) or [link](Link.md). The destination is defined with [set_link](SetLink.md). - -### See also ### - -[cell](Cell.md), [write](Write.md), [image](Image.md), [link](Link.md), [set_link](SetLink.md). diff --git a/docs/reference/Close.md b/docs/reference/Close.md deleted file mode 100644 index f13f0875b..000000000 --- a/docs/reference/Close.md +++ /dev/null @@ -1,15 +0,0 @@ -## close ## - -```python -fpdf.close() -``` - -### Description ### - -Terminates the PDF document. It is not necessary to call this method explicitly because [output](Output.md) does it automatically. -If the document contains no page, [add_page](AddPage.md) is called to prevent from getting an invalid document. - - -### See also ### - -[open](Open.md), [output](Output.md). diff --git a/docs/reference/AcceptPageBreak.md b/docs/reference/accept_page_break.md similarity index 78% rename from docs/reference/AcceptPageBreak.md rename to docs/reference/accept_page_break.md index b0d53932e..de83f3047 100644 --- a/docs/reference/AcceptPageBreak.md +++ b/docs/reference/accept_page_break.md @@ -6,9 +6,9 @@ fpdf.accept_page_break() ### Description ### -Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by [set_auto_page_break](SetAutoPageBreak.md). +Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by [set_auto_page_break](set_auto_page_break.md). This method is called automatically and should not be called directly by the application. ### See also ### -[set_auto_page_break](SetAutoPageBreak.md). +[set_auto_page_break](set_auto_page_break.md). diff --git a/docs/reference/AddFont.md b/docs/reference/add_font.md similarity index 85% rename from docs/reference/AddFont.md rename to docs/reference/add_font.md index 97617b07f..b075527c2 100644 --- a/docs/reference/AddFont.md +++ b/docs/reference/add_font.md @@ -19,7 +19,7 @@ If the file corresponding to the requested font is not found, the runtime except For more information, see [Unicode](../Unicode.md) support page. -The method should be called before [set_font](SetFont.md) method is used, and the font will be available for the whole document. +The method should be called before [set_font](set_font.md) method is used, and the font will be available for the whole document. **Note**: due font processing can occupy large amount of time some data are cached. @@ -32,7 +32,7 @@ Files created in same folder by default. This can be changed by `FPDF_CACHE_MODE ### Parameters ### family: -> Family font. Used as a reference for [set_font](SetFont.md), for example: `'dejavu'` +> Family font. Used as a reference for [set_font](set_font.md), for example: `'dejavu'` style: > Font style. Deprecated, maintained only for backward compatibility. @@ -43,7 +43,7 @@ fname: uni: > TTF Unicode flag (if set to `True`, TrueType font subset embedding will be enabled and text will be treated as `utf8` by default). -You must _not_ call _add_font_ for PDF Standard Latin-1 fonts (Courier, Helvetica, Times, Symbol, Zapfdingbats), use [set_font](SetFont.md) directly in that case. +You must _not_ call _add_font_ for PDF Standard Latin-1 fonts (Courier, Helvetica, Times, Symbol, Zapfdingbats), use [set_font](set_font.md) directly in that case. Calling this method with uni=False is discouraged as legacy font support is complex and deprecated. @@ -60,4 +60,4 @@ pdf.add_font('sysfont', '', r"c:\WINDOWS\Fonts\arial.ttf", uni=True) ### See also ### -[set_font](SetFont.md), [set_font_size](SetFontSize.md), [cell](Cell.md), [multi_cell](MultiCell.md), [write](Write.md). +[set_font](set_font.md), [set_font_size](set_font_size.md), [cell](cell.md), [multi_cell](multi_cell.md), [write](write.md). diff --git a/docs/reference/add_link.md b/docs/reference/add_link.md new file mode 100644 index 000000000..8d0fb933c --- /dev/null +++ b/docs/reference/add_link.md @@ -0,0 +1,14 @@ +## add_link ## + +```python +fpdf.add_link() +``` + +### Description ### + +Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document. +The identifier can then be passed to [cell](cell.md), [write](write.md), [image](image.md) or [link](link.md). The destination is defined with [set_link](set_link.md). + +### See also ### + +[cell](cell.md), [write](write.md), [image](image.md), [link](link.md), [set_link](set_link.md). diff --git a/docs/reference/AddPage.md b/docs/reference/add_page.md similarity index 81% rename from docs/reference/AddPage.md rename to docs/reference/add_page.md index 2ca4faa3e..75d58116c 100644 --- a/docs/reference/AddPage.md +++ b/docs/reference/add_page.md @@ -7,12 +7,12 @@ fpdf.add_page(orientation = '', format = '', same = False) ### Description ### Adds a new page to the document. If a page is already present, the -[footer](Footer.md) method is called first to output the footer. Then the page +[footer](footer.md) method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left -and top margins, and [header](Header.md) is called to display the header. +and top margins, and [header](header.md) is called to display the header. The font which was set before calling is automatically restored. There is no -need to call [set_font](SetFont.md) again if you want to continue with the same +need to call [set_font](set_font.md) again if you want to continue with the same font. Colors and line width also preserved. The origin of the coordinate system is at the top-left corner and increasing @@ -49,5 +49,5 @@ ignored. ### See also ### -[FPDF](FPDF.md), [header](Header.md), [footer](Footer.md), -[set_margins](SetMargins.md). +[FPDF](FPDF.md), [header](header.md), [footer](footer.md), +[set_margins](set_margins.md). diff --git a/docs/reference/AliasNbPages.md b/docs/reference/alias_nb_pages.md similarity index 93% rename from docs/reference/AliasNbPages.md rename to docs/reference/alias_nb_pages.md index 761056e50..3c9dd03c4 100644 --- a/docs/reference/AliasNbPages.md +++ b/docs/reference/alias_nb_pages.md @@ -31,4 +31,4 @@ pdf.alias_nb_pages() ### See also ### -[page_no](PageNo.md), [footer](Footer.md). +[page_no](page_no.md), [footer](footer.md). diff --git a/docs/reference/Cell.md b/docs/reference/cell.md similarity index 80% rename from docs/reference/Cell.md rename to docs/reference/cell.md index ed41dee62..a73733e31 100644 --- a/docs/reference/Cell.md +++ b/docs/reference/cell.md @@ -40,7 +40,7 @@ ln: >> * 1: to the beginning of the next line >> * 2: below > -> Putting 1 is equivalent to putting 0 and calling [ln](Ln.md) just after. Default value: 0. +> Putting 1 is equivalent to putting 0 and calling [ln](ln.md) just after. Default value: 0. align: > Allows to center or align the text. Possible values are: @@ -52,7 +52,7 @@ fill: > Indicates if the cell background must be painted (True) or transparent (False). Default value: False. link: -> URL or identifier returned by [add_link](AddLink.md). +> URL or identifier returned by [add_link](add_link.md). ### Example ### @@ -67,4 +67,4 @@ pdf.cell(20, 10, 'Title', 1, 1, 'C') ### See also ### -[set_font](SetFont.md), [set_draw_color](SetDrawColor.md), [set_fill_color](SetFillColor.md), [set_text_color](SetTextColor.md), [set_line_width](SetLineWidth.md), [add_link](AddLink.md), [ln](Ln.md), [multi_cell](MultiCell.md), [write](Write.md), [set_auto_page_break](SetAutoPageBreak.md). +[set_font](set_font.md), [set_draw_color](set_draw_color.md), [set_fill_color](set_fill_color.md), [set_text_color](set_text_color.md), [set_line_width](set_line_width.md), [add_link](add_link.md), [ln](ln.md), [multi_cell](multi_cell.md), [write](write.md), [set_auto_page_break](set_auto_page_break.md). diff --git a/docs/reference/close.md b/docs/reference/close.md new file mode 100644 index 000000000..a9fd84da9 --- /dev/null +++ b/docs/reference/close.md @@ -0,0 +1,15 @@ +## close ## + +```python +fpdf.close() +``` + +### Description ### + +Terminates the PDF document. It is not necessary to call this method explicitly because [output](output.md) does it automatically. +If the document contains no page, [add_page](add_page.md) is called to prevent from getting an invalid document. + + +### See also ### + +[open](open.md), [output](output.md). diff --git a/docs/reference/DashedLine.md b/docs/reference/dashed_line.md similarity index 88% rename from docs/reference/DashedLine.md rename to docs/reference/dashed_line.md index f82b16f37..40fb14164 100644 --- a/docs/reference/DashedLine.md +++ b/docs/reference/dashed_line.md @@ -6,7 +6,7 @@ fpdf.dashed_line(x1, y1, x2, y2, dash_length = 1, space_length = 1) ### Description ### -Draw a dashed line between two points. Same interface as [line](Line.md) except the two parameters dash\_length and space\_length. +Draw a dashed line between two points. Same interface as [line](line.md) except the two parameters dash\_length and space\_length. ### Parameters ### @@ -39,4 +39,4 @@ pdf.dashed_line(10, 30, 110, 30, 1, 10) ### See also ### -[line](Line.md). +[line](line.md). diff --git a/docs/reference/Ellipse.md b/docs/reference/ellipse.md similarity index 86% rename from docs/reference/Ellipse.md rename to docs/reference/ellipse.md index 53fd562bf..0f3148174 100644 --- a/docs/reference/Ellipse.md +++ b/docs/reference/ellipse.md @@ -8,7 +8,7 @@ fpdf.ellipse(x: float, y: float, w: float, h: float, style = '') Outputs an ellipse. It can be drawn (border only), filled (with no border) or both. Unlike the PHP version, this function uses the top-left position and -width and height of the ellipse, like [rect](Rect.md), not the center point and +width and height of the ellipse, like [rect](rect.md), not the center point and radius. ### Parameters ### @@ -33,4 +33,4 @@ style: ### See also ### -[cell](Cell.md), [rect](Rect.md). +[cell](cell.md), [rect](rect.md). diff --git a/docs/reference/Error.md b/docs/reference/error.md similarity index 100% rename from docs/reference/Error.md rename to docs/reference/error.md diff --git a/docs/reference/Footer.md b/docs/reference/footer.md similarity index 61% rename from docs/reference/Footer.md rename to docs/reference/footer.md index e47feba49..2661b8829 100644 --- a/docs/reference/Footer.md +++ b/docs/reference/footer.md @@ -6,7 +6,7 @@ fpdf.footer() ### Description ### -This method is used to render the page footer. It is automatically called by [add_page](AddPage.md) and [close](Close.md) and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing. +This method is used to render the page footer. It is automatically called by [add_page](add_page.md) and [close](close.md) and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing. ### Example ### ```python @@ -22,4 +22,4 @@ class PDF(FPDF): ### See also ### -[add_page](AddPage.md), [header](Header.md). +[add_page](add_page.md), [header](header.md). diff --git a/docs/reference/GetStringWidth.md b/docs/reference/get_string_width.md similarity index 88% rename from docs/reference/GetStringWidth.md rename to docs/reference/get_string_width.md index 7abf9af92..57900343a 100644 --- a/docs/reference/GetStringWidth.md +++ b/docs/reference/get_string_width.md @@ -17,4 +17,4 @@ s: ### See also ### -[set_stretching](SetStretching.md). +[set_stretching](set_stretching.md). diff --git a/docs/reference/GetX.md b/docs/reference/get_x.md similarity index 61% rename from docs/reference/GetX.md rename to docs/reference/get_x.md index 4cc44bb53..bef688437 100644 --- a/docs/reference/GetX.md +++ b/docs/reference/get_x.md @@ -10,4 +10,4 @@ Returns the abscissa of the current position. ### See also ### -[get_y](GetY.md), [set_x](SetX.md), [set_y](SetY.md), [set_xy](SetXY.md). +[get_y](get_y.md), [set_x](set_x.md), [set_y](set_y.md), [set_xy](set_xy.md). diff --git a/docs/reference/GetY.md b/docs/reference/get_y.md similarity index 61% rename from docs/reference/GetY.md rename to docs/reference/get_y.md index eecf6e2d4..895456c20 100644 --- a/docs/reference/GetY.md +++ b/docs/reference/get_y.md @@ -10,4 +10,4 @@ Returns the ordinate of the current position. ### See also ### -[get_x](GetX.md), [set_x](SetX.md), [set_y](SetY.md), [set_xy](SetXY.md). +[get_x](get_x.md), [set_x](set_x.md), [set_y](set_y.md), [set_xy](set_xy.md). diff --git a/docs/reference/Header.md b/docs/reference/header.md similarity index 63% rename from docs/reference/Header.md rename to docs/reference/header.md index 82b45d76e..ee6a3e2f5 100644 --- a/docs/reference/Header.md +++ b/docs/reference/header.md @@ -6,7 +6,7 @@ fdpf.header() ### Description ### -This method is used to render the page header. It is automatically called by [add_page](AddPage.md) and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing. +This method is used to render the page header. It is automatically called by [add_page](add_page.md) and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing. ### Example ### @@ -25,4 +25,4 @@ class PDF(FPDF): ### See also ### -[add_page](AddPage.md), [footer](Footer.md). +[add_page](add_page.md), [footer](footer.md). diff --git a/docs/reference/Image.md b/docs/reference/image.md similarity index 96% rename from docs/reference/Image.md rename to docs/reference/image.md index 90da44bd0..727a5d619 100644 --- a/docs/reference/Image.md +++ b/docs/reference/image.md @@ -62,9 +62,9 @@ type: > Image format. Possible values are (case insensitive): JPG, JPEG, PNG and GIF. If not specified, the type is inferred from the file extension. link: -> URL or identifier returned by [add_link](AddLink.md). +> URL or identifier returned by [add_link](add_link.md). ### See also ### -[add_link](AddLink.md). +[add_link](add_link.md). diff --git a/docs/reference/Line.md b/docs/reference/line.md similarity index 92% rename from docs/reference/Line.md rename to docs/reference/line.md index 1b48c4229..e131e501b 100644 --- a/docs/reference/Line.md +++ b/docs/reference/line.md @@ -31,4 +31,4 @@ pdf.line(10, 30, 110, 30) ### See also ### -[dashed_line](DashedLine.md). +[dashed_line](dashed_line.md). diff --git a/docs/reference/Link.md b/docs/reference/link.md similarity index 61% rename from docs/reference/Link.md rename to docs/reference/link.md index 24a42c928..5464a0ed4 100644 --- a/docs/reference/Link.md +++ b/docs/reference/link.md @@ -6,7 +6,7 @@ fpdf.link(x: float, y: float, w: float, h: float, link) ### Description ### -Puts a link on a rectangular area of the page. Text or image links are generally put via [cell](Cell.md), [write](Write.md) or [image](Image.md), but this method can be useful for instance to define a clickable area inside an image. +Puts a link on a rectangular area of the page. Text or image links are generally put via [cell](cell.md), [write](write.md) or [image](image.md), but this method can be useful for instance to define a clickable area inside an image. ### Parameters ### @@ -23,8 +23,8 @@ h: > Height of the rectangle. link: -> URL or identifier returned by [add_link](AddLink.md). +> URL or identifier returned by [add_link](add_link.md). ### See also ### -[add_link](AddLink.md), [cell](Cell.md), [write](Write.md), [image](Image.md). +[add_link](add_link.md), [cell](cell.md), [write](write.md), [image](image.md). diff --git a/docs/reference/Ln.md b/docs/reference/ln.md similarity index 95% rename from docs/reference/Ln.md rename to docs/reference/ln.md index e4f2b9b97..7a1b918d0 100644 --- a/docs/reference/Ln.md +++ b/docs/reference/ln.md @@ -17,4 +17,4 @@ h: ### See also ### -[cell](Cell.md). +[cell](cell.md). diff --git a/docs/reference/MultiCell.md b/docs/reference/multi_cell.md similarity index 83% rename from docs/reference/MultiCell.md rename to docs/reference/multi_cell.md index 824132abb..a19ccd640 100644 --- a/docs/reference/MultiCell.md +++ b/docs/reference/multi_cell.md @@ -44,4 +44,4 @@ fill ### See also ### -[set_font](SetFont.md), [set_draw_color](SetDrawColor.md), [set_fill_color](SetFillColor.md), [set_text_color](SetTextColor.md), [set_line_width](SetLineWidth.md), [cell](Cell.md), [write](Write.md), [set_auto_page_break](SetAutoPageBreak.md). +[set_font](set_font.md), [set_draw_color](set_draw_color.md), [set_fill_color](set_fill_color.md), [set_text_color](set_text_color.md), [set_line_width](set_line_width.md), [cell](cell.md), [write](write.md), [set_auto_page_break](set_auto_page_break.md). diff --git a/docs/reference/Open.md b/docs/reference/open.md similarity index 58% rename from docs/reference/Open.md rename to docs/reference/open.md index e3b6c1fba..16d2b1d93 100644 --- a/docs/reference/Open.md +++ b/docs/reference/open.md @@ -6,11 +6,11 @@ fpdf.open() ### Description ### -This method begins the generation of the PDF document. It is not necessary to call it explicitly because [add_page](AddPage.md) does it automatically. +This method begins the generation of the PDF document. It is not necessary to call it explicitly because [add_page](add_page.md) does it automatically. Note: no page is created by this method. ### See also ### -[add_page](AddPage.md), [close](Close.md). +[add_page](add_page.md), [close](close.md). diff --git a/docs/reference/Output.md b/docs/reference/output.md similarity index 88% rename from docs/reference/Output.md rename to docs/reference/output.md index 173258c74..82136f246 100644 --- a/docs/reference/Output.md +++ b/docs/reference/output.md @@ -8,7 +8,7 @@ fpdf.output(name = '', dest = '') Send the document to some destination: standard output, a file or a byte string. -The method first calls [close](Close.md) if necessary to terminate the document. +The method first calls [close](close.md) if necessary to terminate the document. ### Parameters ### @@ -23,4 +23,4 @@ dest: ### See also ### -[close](Close.md). +[close](close.md). diff --git a/docs/reference/PageNo.md b/docs/reference/page_no.md similarity index 76% rename from docs/reference/PageNo.md rename to docs/reference/page_no.md index 0d13f350d..85e434bfc 100644 --- a/docs/reference/PageNo.md +++ b/docs/reference/page_no.md @@ -10,4 +10,4 @@ Returns the current page number. ### See also ### -[alias_nb_pages](AliasNbPages.md). +[alias_nb_pages](alias_nb_pages.md). diff --git a/docs/reference/Rect.md b/docs/reference/rect.md similarity index 92% rename from docs/reference/Rect.md rename to docs/reference/rect.md index b98df1e91..e9ac6e301 100644 --- a/docs/reference/Rect.md +++ b/docs/reference/rect.md @@ -31,4 +31,4 @@ style: ### See also ### -[cell](Cell.md), [ellipse](Ellipse.md). +[cell](cell.md), [ellipse](ellipse.md). diff --git a/docs/reference/SetAuthor.md b/docs/reference/set_author.md similarity index 61% rename from docs/reference/SetAuthor.md rename to docs/reference/set_author.md index 285b1e3ca..c8a06d3cb 100644 --- a/docs/reference/SetAuthor.md +++ b/docs/reference/set_author.md @@ -14,4 +14,4 @@ author: ### See also ### -[set_creator](SetCreator.md), [set_keywords](SetKeywords.md), [set_subject](SetSubject.md), [set_title](SetTitle.md). +[set_creator](set_creator.md), [set_keywords](set_keywords.md), [set_subject](set_subject.md), [set_title](set_title.md). diff --git a/docs/reference/SetAutoPageBreak.md b/docs/reference/set_auto_page_break.md similarity index 84% rename from docs/reference/SetAutoPageBreak.md rename to docs/reference/set_auto_page_break.md index 6dfb2395b..f6e39f52b 100644 --- a/docs/reference/SetAutoPageBreak.md +++ b/docs/reference/set_auto_page_break.md @@ -18,4 +18,4 @@ margin: ### See also ### -[cell](Cell.md), [multi_cell](MultiCell.md), [accept_page_break](AcceptPageBreak.md). +[cell](cell.md), [multi_cell](multi_cell.md), [accept_page_break](accept_page_break.md). diff --git a/docs/reference/SetCompression.md b/docs/reference/set_compression.md similarity index 100% rename from docs/reference/SetCompression.md rename to docs/reference/set_compression.md diff --git a/docs/reference/SetCreator.md b/docs/reference/set_creator.md similarity index 69% rename from docs/reference/SetCreator.md rename to docs/reference/set_creator.md index 9f672a6e3..59b0bd1f2 100644 --- a/docs/reference/SetCreator.md +++ b/docs/reference/set_creator.md @@ -14,4 +14,4 @@ creator: ### See also ### -[set_author](SetAuthor.md), [set_keywords](SetKeywords.md), [set_subject](SetSubject.md), [set_title](SetTitle.md). +[set_author](set_author.md), [set_keywords](set_keywords.md), [set_subject](set_subject.md), [set_title](set_title.md). diff --git a/docs/reference/SetDisplayMode.md b/docs/reference/set_display_mode.md similarity index 100% rename from docs/reference/SetDisplayMode.md rename to docs/reference/set_display_mode.md diff --git a/docs/reference/SetDrawColor.md b/docs/reference/set_draw_color.md similarity index 79% rename from docs/reference/SetDrawColor.md rename to docs/reference/set_draw_color.md index eac5aee09..30c34e9fd 100644 --- a/docs/reference/SetDrawColor.md +++ b/docs/reference/set_draw_color.md @@ -21,4 +21,4 @@ b: ### See also ### -[set_fill_color](SetFillColor.md), [set_text_color](SetTextColor.md), [line](Line.md), [rect](Rect.md), [cell](Cell.md), [multi_cell](MultiCell.md). +[set_fill_color](set_fill_color.md), [set_text_color](set_text_color.md), [line](line.md), [rect](rect.md), [cell](cell.md), [multi_cell](multi_cell.md). diff --git a/docs/reference/SetFillColor.md b/docs/reference/set_fill_color.md similarity index 81% rename from docs/reference/SetFillColor.md rename to docs/reference/set_fill_color.md index 667192efd..a831d67a6 100644 --- a/docs/reference/SetFillColor.md +++ b/docs/reference/set_fill_color.md @@ -21,4 +21,4 @@ b: ### See also ### -[set_draw_color](SetDrawColor.md), [set_text_color](SetTextColor.md), [rect](Rect.md), [cell](Cell.md), [multi_cell](MultiCell.md). +[set_draw_color](set_draw_color.md), [set_text_color](set_text_color.md), [rect](rect.md), [cell](cell.md), [multi_cell](multi_cell). diff --git a/docs/reference/SetFont.md b/docs/reference/set_font.md similarity index 82% rename from docs/reference/SetFont.md rename to docs/reference/set_font.md index 7fb780846..e9617968f 100644 --- a/docs/reference/SetFont.md +++ b/docs/reference/set_font.md @@ -8,11 +8,11 @@ fpdf.set_font(family, style = '', size = 0) Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid. -The font can be either a standard one or a font added via the [add_font](AddFont.md) method. Standard fonts use Windows encoding cp1252 (Western Europe). +The font can be either a standard one or a font added via the [add_font](add_font.md) method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. -If you just wish to change the current font size, it is simpler to call [set_font_size](SetFontSize.md). +If you just wish to change the current font size, it is simpler to call [set_font_size](set_font_size.md). **Note**: the font metric files must be accessible. They are searched successively in: @@ -29,7 +29,7 @@ If the file corresponding to the requested font is not found, the error "Could n ### Parameters ### family: -> Family font. It can be either a name defined by [add_font](AddFont.md) or one of the standard families (case insensitive): +> Family font. It can be either a name defined by [add_font](add_font.md) or one of the standard families (case insensitive): >> * Courier (fixed-width) >> * Helvetica or Arial (synonymous; sans serif) >> * Times (serif) @@ -66,4 +66,4 @@ pdf.set_font('Times', 'BIU') ### See also ### -[add_font](AddFont.md), [set_font_size](SetFontSize.md), [cell](Cell.md), [multi_cell](MultiCell.md), [write](Write.md), [set_stretching](SetStretching.md). +[add_font](add_font.md), [set_font_size](set_font_size.md), [cell](cell.md), [multi_cell](multi_cell.md), [write](write.md), [set_stretching](set_stretching.md). diff --git a/docs/reference/SetFontSize.md b/docs/reference/set_font_size.md similarity index 88% rename from docs/reference/SetFontSize.md rename to docs/reference/set_font_size.md index b5b1848e2..c5b96b56b 100644 --- a/docs/reference/SetFontSize.md +++ b/docs/reference/set_font_size.md @@ -16,4 +16,4 @@ size: ### See also ### -[set_font](SetFont.md). +[set_font](set_font.md). diff --git a/docs/reference/SetKeywords.md b/docs/reference/set_keywords.md similarity index 67% rename from docs/reference/SetKeywords.md rename to docs/reference/set_keywords.md index 06549b1ca..e86b75f42 100644 --- a/docs/reference/SetKeywords.md +++ b/docs/reference/set_keywords.md @@ -14,4 +14,4 @@ keywords: ### See also ### -[set_author](SetAuthor.md), [set_creator](SetCreator.md), [set_subject](SetSubject.md), [set_title](SetTitle.md). +[set_author](set_author.md), [set_creator](set_creator.md), [set_subject](set_subject.md), [set_title](set_title.md). diff --git a/docs/reference/SetLeftMargin.md b/docs/reference/set_left_margin.md similarity index 66% rename from docs/reference/SetLeftMargin.md rename to docs/reference/set_left_margin.md index f8ef57989..6383b3131 100644 --- a/docs/reference/SetLeftMargin.md +++ b/docs/reference/set_left_margin.md @@ -16,4 +16,4 @@ margin: ### See also ### -[set_top_margin](SetTopMargin.md), [set_right_margin](SetRightMargin.md), [set_auto_page_break](SetAutoPageBreak.md), [set_margins](SetMargins.md). +[set_top_margin](set_top_margin.md), [set_right_margin](set_right_margin.md), [set_auto_page_break](set_auto_page_break.md), [set_margins](set_margins.md). diff --git a/docs/reference/SetLineWidth.md b/docs/reference/set_line_width.md similarity index 79% rename from docs/reference/SetLineWidth.md rename to docs/reference/set_line_width.md index 6a4eb0e3f..645f2ad25 100644 --- a/docs/reference/SetLineWidth.md +++ b/docs/reference/set_line_width.md @@ -15,4 +15,4 @@ width: ### See also ### -[line](Line.md), [rect](Rect.md), [cell](Cell.md), [multi_cell](MultiCell.md). +[line](line.md), [rect](rect.md), [cell](cell.md), [multi_cell](multi_cell.md). diff --git a/docs/reference/SetLink.md b/docs/reference/set_link.md similarity index 82% rename from docs/reference/SetLink.md rename to docs/reference/set_link.md index c5af3451e..035451b4e 100644 --- a/docs/reference/SetLink.md +++ b/docs/reference/set_link.md @@ -10,7 +10,7 @@ Defines the page and position a link points to. ### Parameters ### link: -> The link identifier returned by [add_link](AddLink.md). +> The link identifier returned by [add_link](add_link.md). y: > Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page). @@ -21,4 +21,4 @@ page: ### See also ### -[add_link](AddLink.md). +[add_link](add_link.md). diff --git a/docs/reference/SetMargins.md b/docs/reference/set_margins.md similarity index 68% rename from docs/reference/SetMargins.md rename to docs/reference/set_margins.md index 6e98d238c..b68946fb8 100644 --- a/docs/reference/SetMargins.md +++ b/docs/reference/set_margins.md @@ -21,4 +21,4 @@ right: ### See also ### -[set_top_margin](SetTopMargin.md), [set_left_margin](SetLeftMargin.md), [set_right_margin](SetRightMargin.md), [set_auto_page_break](SetAutoPageBreak.md). +[set_top_margin](set_top_margin.md), [set_left_margin](set_left_margin.md), [set_right_margin](set_right_margin.md), [set_auto_page_break](set_auto_page_break.md). diff --git a/docs/reference/SetRightMargin.md b/docs/reference/set_right_margin.md similarity index 61% rename from docs/reference/SetRightMargin.md rename to docs/reference/set_right_margin.md index 8253bc006..19718caf9 100644 --- a/docs/reference/SetRightMargin.md +++ b/docs/reference/set_right_margin.md @@ -15,4 +15,4 @@ margin: ### See also ### -[set_top_margin](SetTopMargin.md), [set_left_margin](SetLeftMargin.md), [set_auto_page_break](SetAutoPageBreak.md), [set_margins](SetMargins.md). +[set_top_margin](set_top_margin.md), [set_left_margin](set_left_margin.md), [set_auto_page_break](set_auto_page_break.md), [set_margins](set_margins.md). diff --git a/docs/reference/SetStretching.md b/docs/reference/set_stretching.md similarity index 83% rename from docs/reference/SetStretching.md rename to docs/reference/set_stretching.md index 61ca5d0f7..bfb2db737 100644 --- a/docs/reference/SetStretching.md +++ b/docs/reference/set_stretching.md @@ -28,4 +28,4 @@ pdf.set_stretching(50.0) ### See also ### -[set_font](SetFont.md), [set_font_size](SetFontSize.md), [get_string_width](GetStringWidth.md). +[set_font](set_font.md), [set_font_size](set_font_size.md), [get_string_width](get_string_width.md). diff --git a/docs/reference/SetSubject.md b/docs/reference/set_subject.md similarity index 60% rename from docs/reference/SetSubject.md rename to docs/reference/set_subject.md index eb42f5748..fb954a98c 100644 --- a/docs/reference/SetSubject.md +++ b/docs/reference/set_subject.md @@ -14,4 +14,4 @@ subject: ### See also ### -[set_author](SetAuthor.md), [set_creator](SetCreator.md), [set_keywords](SetKeywords.md), [set_title](SetTitle.md). +[set_author](set_author.md), [set_creator](set_creator.md), [set_keywords](set_keywords.md), [set_title](set_title.md). diff --git a/docs/reference/SetTextColor.md b/docs/reference/set_text_color.md similarity index 79% rename from docs/reference/SetTextColor.md rename to docs/reference/set_text_color.md index 06a9d759a..ab8838079 100644 --- a/docs/reference/SetTextColor.md +++ b/docs/reference/set_text_color.md @@ -21,4 +21,4 @@ b: ### See also ### -[set_draw_color](SetDrawColor.md), [set_fill_color](SetFillColor.md), [text](Text.md), [cell](Cell.md), [multi_cell](MultiCell.md). +[set_draw_color](set_draw_color.md), [set_fill_color](set_fill_color.md), [text](text.md), [cell](cell.md), [multi_cell](multi_cell.md). diff --git a/docs/reference/SetTitle.md b/docs/reference/set_title.md similarity index 58% rename from docs/reference/SetTitle.md rename to docs/reference/set_title.md index 1c9aa19de..1a661e9a1 100644 --- a/docs/reference/SetTitle.md +++ b/docs/reference/set_title.md @@ -14,4 +14,4 @@ title: ### See also ### -[set_author](SetAuthor.md), [set_creator](SetCreator.md), [set_keywords](SetKeywords.md), [set_subject](SetSubject.md). +[set_author](set_author.md), [set_creator](set_creator.md), [set_keywords](set_keywords.md), [set_subject](set_subject.md). diff --git a/docs/reference/SetTopMargin.md b/docs/reference/set_top_margin.md similarity index 59% rename from docs/reference/SetTopMargin.md rename to docs/reference/set_top_margin.md index d72907a86..ddc32fa1b 100644 --- a/docs/reference/SetTopMargin.md +++ b/docs/reference/set_top_margin.md @@ -15,4 +15,4 @@ margin: ### See also ### -[set_left_margin](SetLeftMargin.md), [set_right_margin](SetRightMargin.md), [set_auto_page_break](SetAutoPageBreak.md), [set_margins](SetMargins.md). +[set_left_margin](set_left_margin.md), [set_right_margin](set_right_margin.md), [set_auto_page_break](set_auto_page_break.md), [set_margins](set_margins.md). diff --git a/docs/reference/SetX.md b/docs/reference/set_x.md similarity index 76% rename from docs/reference/SetX.md rename to docs/reference/set_x.md index 05d126292..4994b91e2 100644 --- a/docs/reference/SetX.md +++ b/docs/reference/set_x.md @@ -14,4 +14,4 @@ x: ### See also ### -[get_x](GetX.md), [get_y](GetY.md), [set_y](SetY.md), [set_xy](SetXY.md). +[get_x](get_x.md), [get_y](get_y.md), [set_y](set_y.md), [set_xy](set_xy.md). diff --git a/docs/reference/SetXY.md b/docs/reference/set_xy.md similarity index 82% rename from docs/reference/SetXY.md rename to docs/reference/set_xy.md index 0668eaac6..ea1b129b8 100644 --- a/docs/reference/SetXY.md +++ b/docs/reference/set_xy.md @@ -17,4 +17,4 @@ y: ### See also ### -[get_x](GetX.md), [get_y](GetY.md), [set_x](SetX.md), [set_y](SetY.md). +[get_x](get_x.md), [get_y](get_y.md), [set_x](set_x.md), [set_y](set_y.md). diff --git a/docs/reference/SetY.md b/docs/reference/set_y.md similarity index 78% rename from docs/reference/SetY.md rename to docs/reference/set_y.md index e6bd1a092..ee7d15c51 100644 --- a/docs/reference/SetY.md +++ b/docs/reference/set_y.md @@ -14,4 +14,4 @@ y: ### See also ### -[get_x](GetX.md), [get_y](GetY.md), [set_x](SetX.md), [set_xy](SetXY.md). +[get_x](get_x.md), [get_y](get_y.md), [set_x](set_x.md), [set_xy](set_xy.md). diff --git a/docs/reference/Text.md b/docs/reference/text.md similarity index 63% rename from docs/reference/Text.md rename to docs/reference/text.md index e50c0fd45..1ba6df855 100644 --- a/docs/reference/Text.md +++ b/docs/reference/text.md @@ -5,7 +5,7 @@ fpdf.text(x: float, y: float, txt: str) ``` ### Description ### -Prints a character string. The origin is on the left of the first character, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use [cell](Cell.md), [multi_cell](MultiCell.md) or [write](Write.md) which are the standard methods to print text. +Prints a character string. The origin is on the left of the first character, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use [cell](cell.md), [multi_cell](multi_cell.md) or [write](write.md) which are the standard methods to print text. ### Parameters ### @@ -20,4 +20,4 @@ txt: ### See also ### -[set_font](SetFont.md), [set_text_color](SetTextColor.md), [cell](Cell.md), [multi_cell](MultiCell.md), [write](Write.md). +[set_font](set_font.md), [set_text_color](set_text_color.md), [cell](cell.md), [multi_cell](multi_cell.md), [write](write.md). diff --git a/docs/reference/Write.md b/docs/reference/write.md similarity index 74% rename from docs/reference/Write.md rename to docs/reference/write.md index ab3931d94..26c480d9a 100644 --- a/docs/reference/Write.md +++ b/docs/reference/write.md @@ -18,7 +18,7 @@ txt: > String to print. link: -> URL or identifier returned by [add_link](AddLink.md). +> URL or identifier returned by [add_link](add_link.md). ### Example ### ```python @@ -33,4 +33,4 @@ pdf.write(5, 'www.fpdf.org', 'http://www.fpdf.org') ### See also ### -[set_font](SetFont.md), [set_text_color](SetTextColor.md), [add_link](AddLink.md), [multi_cell](MultiCell.md), [set_auto_page_break](SetAutoPageBreak.md), [write_html](WriteHTML.md) +[set_font](set_font.md), [set_text_color](set_text_color.md), [add_link](add_link.md), [multi_cell](multi_cell.md), [set_auto_page_break](set_auto_page_break.md), [write_html](write_html.md) diff --git a/docs/reference/WriteHTML.md b/docs/reference/write_html.md similarity index 97% rename from docs/reference/WriteHTML.md rename to docs/reference/write_html.md index 9b95d96e8..7b941923f 100644 --- a/docs/reference/WriteHTML.md +++ b/docs/reference/write_html.md @@ -86,5 +86,5 @@ pdf.output('html.pdf', 'F') See html.py or [Web2Py](../Web2Py.md) for a complete example ### See also ### -[write](Write.md), [add_font](AddFont.md), [image](Image.md). +[write](write.md), [add_font](add_font.md), [image](image.md). diff --git a/mkdocs.yml b/mkdocs.yml index e654a08ad..2dcb7bb82 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,55 +20,55 @@ pages: - [Web2Py.md, "Web2Py framework"] - [Testing.md, "Testing"] - [Development.md, "Development"] -- ["reference/AcceptPageBreak.md", "Reference manual", "accept_page_break"] -- ["reference/AddFont.md", "Reference manual", "add_font"] -- ["reference/AddLink.md", "Reference manual", "add_link"] -- ["reference/AddPage.md", "Reference manual", "add_page"] -- ["reference/AliasNbPages.md", "Reference manual", "alias_nb_pages"] -- ["reference/Cell.md", "Reference manual", "cell"] -- ["reference/Close.md", "Reference manual", "close"] -- ["reference/DashedLine.md", "Reference manual", "dashed_line"] -- ["reference/Ellipse.md", "Reference manual", "ellipse"] -- ["reference/Error.md", "Reference manual", "error"] +- ["reference/accept_page_break.md", "Reference manual", "accept_page_break"] +- ["reference/add_font.md", "Reference manual", "add_font"] +- ["reference/add_link.md", "Reference manual", "add_link"] +- ["reference/add_page.md", "Reference manual", "add_page"] +- ["reference/alias_nb_pages.md", "Reference manual", "alias_nb_pages"] +- ["reference/cell.md", "Reference manual", "cell"] +- ["reference/close.md", "Reference manual", "close"] +- ["reference/dashed_line.md", "Reference manual", "dashed_line"] +- ["reference/ellipse.md", "Reference manual", "ellipse"] +- ["reference/error.md", "Reference manual", "error"] - ["reference/FPDF.md", "Reference manual", "FPDF"] -- ["reference/Footer.md", "Reference manual", "footer"] -- ["reference/GetStringWidth.md", "Reference manual", "get_string_width"] -- ["reference/GetX.md", "Reference manual", "get_x"] -- ["reference/GetY.md", "Reference manual", "get_y"] -- ["reference/Header.md", "Reference manual", "header"] -- ["reference/Image.md", "Reference manual", "image"] -- ["reference/Line.md", "Reference manual", "line"] -- ["reference/Link.md", "Reference manual", "link"] -- ["reference/Ln.md", "Reference manual", "ln"] -- ["reference/MultiCell.md", "Reference manual", "multi_cell"] -- ["reference/Open.md", "Reference manual", "open"] -- ["reference/Output.md", "Reference manual", "output"] -- ["reference/PageNo.md", "Reference manual", "page_no"] -- ["reference/Rect.md", "Reference manual", "rect"] -- ["reference/SetAuthor.md", "Reference manual", "set_author"] -- ["reference/SetAutoPageBreak.md", "Reference manual", "set_auto_page_break"] -- ["reference/SetCompression.md", "Reference manual", "set_compression"] -- ["reference/SetCreator.md", "Reference manual", "set_creator"] -- ["reference/SetDisplayMode.md", "Reference manual", "set_display_mode"] -- ["reference/SetDrawColor.md", "Reference manual", "set_draw_color"] -- ["reference/SetFillColor.md", "Reference manual", "set_fill_color"] -- ["reference/SetFont.md", "Reference manual", "set_font"] -- ["reference/SetFontSize.md", "Reference manual", "set_font_size"] -- ["reference/SetKeywords.md", "Reference manual", "set_keywords"] -- ["reference/SetLeftMargin.md", "Reference manual", "set_left_margin"] -- ["reference/SetLineWidth.md", "Reference manual", "set_line_width"] -- ["reference/SetLink.md", "Reference manual", "set_link"] -- ["reference/SetMargins.md", "Reference manual", "set_margins"] -- ["reference/SetRightMargin.md", "Reference manual", "set_right_margin"] -- ["reference/SetStretching.md", "Reference manual", "set_stretching"] -- ["reference/SetSubject.md", "Reference manual", "set_subject"] -- ["reference/SetTextColor.md", "Reference manual", "set_text_color"] -- ["reference/SetTitle.md", "Reference manual", "set_title"] -- ["reference/SetTopMargin.md", "Reference manual", "set_top_margin"] -- ["reference/SetX.md", "Reference manual", "set_x"] -- ["reference/SetXY.md", "Reference manual", "set_xy"] -- ["reference/SetY.md", "Reference manual", "set_y"] -- ["reference/Text.md", "Reference manual", "text"] -- ["reference/Write.md", "Reference manual", "write"] -- ["reference/WriteHTML.md", "Reference manual", "write_html"] +- ["reference/footer.md", "Reference manual", "footer"] +- ["reference/get_string_width.md", "Reference manual", "get_string_width"] +- ["reference/get_x.md", "Reference manual", "get_x"] +- ["reference/get_y.md", "Reference manual", "get_y"] +- ["reference/header.md", "Reference manual", "header"] +- ["reference/image.md", "Reference manual", "image"] +- ["reference/line.md", "Reference manual", "line"] +- ["reference/link.md", "Reference manual", "link"] +- ["reference/ln.md", "Reference manual", "ln"] +- ["reference/multi_cell.md", "Reference manual", "multi_cell"] +- ["reference/open.md", "Reference manual", "open"] +- ["reference/output.md", "Reference manual", "output"] +- ["reference/page_no.md", "Reference manual", "page_no"] +- ["reference/rect.md", "Reference manual", "rect"] +- ["reference/set_author.md", "Reference manual", "set_author"] +- ["reference/set_auto_page_break.md", "Reference manual", "set_auto_page_break"] +- ["reference/set_compression.md", "Reference manual", "set_compression"] +- ["reference/set_creator.md", "Reference manual", "set_creator"] +- ["reference/set_display_mode.md", "Reference manual", "set_display_mode"] +- ["reference/set_draw_color.md", "Reference manual", "set_draw_color"] +- ["reference/set_fill_color.md", "Reference manual", "set_fill_color"] +- ["reference/set_font.md", "Reference manual", "set_font"] +- ["reference/set_font_size.md", "Reference manual", "set_font_size"] +- ["reference/set_keywords.md", "Reference manual", "set_keywords"] +- ["reference/set_left_margin.md", "Reference manual", "set_left_margin"] +- ["reference/set_line_width.md", "Reference manual", "set_line_width"] +- ["reference/set_link.md", "Reference manual", "set_link"] +- ["reference/set_margins.md", "Reference manual", "set_margins"] +- ["reference/set_right_margin.md", "Reference manual", "set_right_margin"] +- ["reference/set_stretching.md", "Reference manual", "set_stretching"] +- ["reference/set_subject.md", "Reference manual", "set_subject"] +- ["reference/set_text_color.md", "Reference manual", "set_text_color"] +- ["reference/set_title.md", "Reference manual", "set_title"] +- ["reference/set_top_margin.md", "Reference manual", "set_top_margin"] +- ["reference/set_x.md", "Reference manual", "set_x"] +- ["reference/set_xy.md", "Reference manual", "set_xy"] +- ["reference/set_y.md", "Reference manual", "set_y"] +- ["reference/text.md", "Reference manual", "text"] +- ["reference/write.md", "Reference manual", "write"] +- ["reference/write_html.md", "Reference manual", "write_html"]