Skip to content

Commit 906b102

Browse files
committed
more docu updates
1 parent 3460e77 commit 906b102

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/page.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,7 @@ In a nutshell, this is what you can do with PyMuPDF:
839839

840840
.. method:: getPixmap(matrix=fitz.Identity, colorspace=fitz.csRGB, clip=None, alpha=False, annots=True)
841841

842-
Create a pixmap from the page. This is probably the most often used method to create a pixmap.
842+
Create a pixmap from the page. This is probably the most often used method to create a :ref:`Pixmap`.
843843

844844
:arg matrix_like matrix: default is :ref:`Identity`.
845845
:arg colorspace: Defines the required colorspace, one of "GRAY", "RGB" or "CMYK" (case insensitive). Or specify a :ref:`Colorspace`, ie. one of the predefined ones: :data:`csGRAY`, :data:`csRGB` or :data:`csCMYK`.
@@ -859,10 +859,10 @@ In a nutshell, this is what you can do with PyMuPDF:
859859

860860
.. image:: images/img-alpha-0.png
861861

862-
:arg bool annots: *(new in vrsion 1.16.0)* whether to also render any annotations on the page. You can create pixmaps for annotations separately.
862+
:arg bool annots: *(new in vrsion 1.16.0)* whether to also render annotations or to suppress them. You can create pixmaps for annotations separately.
863863

864864
:rtype: :ref:`Pixmap`
865-
:returns: Pixmap of the page.
865+
:returns: Pixmap of the page. For fine-controlling the generated image, the by far most important parameter is **matrix**. E.g. you can increase or decrease the image resolution by using **Matrix(xzoom, yzoom)**. If zoom > 1, you will get a higher resolution: zoom=2 will double the number of pixels in that direction and thus generate a 2 times larger image. Non-positive values will flip horizontally, resp. vertically. Similarly, matrices also let you rotate or shear, and you can combine effects via e.g. matrix multiplication. See the :ref:`Matrix` section to learn more.
866866

867867
.. method:: annot_names()
868868

@@ -880,7 +880,7 @@ In a nutshell, this is what you can do with PyMuPDF:
880880
PDF only: return a list of the :data`xref` numbers of annotations, widgets and links -- technically of all entries found in the page's */Annots* array.
881881

882882
:rtype: list
883-
:returns: a list of items *(xref, type)* where type is the annotation type.Obviously, the type can be used to tell apart links, fields and annotations.
883+
:returns: a list of items *(xref, type)* where type is the annotation type. Use the type to tell apart links, fields and annotations, see :ref:`AnnotationTypes`.
884884

885885

886886
.. method:: load_annot(ident)

docs/vars.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,10 +265,12 @@ See chapter 8.4.5, pp. 615 of the :ref:`AdobeManual` for details.
265265

266266
Annotation Types
267267
~~~~~~~~~~~~~~~~~
268+
These identifiers also cover **links** and **widgets**: the PDF specification technically handles them all in the same way, whereas **MuPDF** (and PyMuPDF) treats them as three basically different types of objects.
269+
268270
::
269271

270272
PDF_ANNOT_TEXT 0
271-
PDF_ANNOT_LINK 1
273+
PDF_ANNOT_LINK 1 # <=== Link object in PyMuPDF
272274
PDF_ANNOT_FREE_TEXT 2
273275
PDF_ANNOT_LINE 3
274276
PDF_ANNOT_SQUARE 4
@@ -287,7 +289,7 @@ Annotation Types
287289
PDF_ANNOT_FILE_ATTACHMENT 17
288290
PDF_ANNOT_SOUND 18
289291
PDF_ANNOT_MOVIE 19
290-
PDF_ANNOT_WIDGET 20
292+
PDF_ANNOT_WIDGET 20 # <=== Widget object in PyMuPDF
291293
PDF_ANNOT_SCREEN 21
292294
PDF_ANNOT_PRINTER_MARK 22
293295
PDF_ANNOT_TRAP_NET 23

0 commit comments

Comments
 (0)