Skip to content

Commit

Permalink
Rename method reference pages after their Python name
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Panter committed Apr 12, 2015
1 parent 6936f26 commit 6c601de
Show file tree
Hide file tree
Showing 59 changed files with 235 additions and 235 deletions.
2 changes: 1 addition & 1 deletion docs/FAQ.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
98 changes: 49 additions & 49 deletions docs/ReferenceManual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

26 changes: 13 additions & 13 deletions docs/Tutorial-es.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ 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)
```

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)
Expand All @@ -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).

Expand Down Expand Up @@ -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 ##
Expand Down Expand Up @@ -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 ##

Expand Down
Loading

0 comments on commit 6c601de

Please sign in to comment.