Prince may be called from the command-line with the following arguments:
prince OPTIONS
FILES
[-o PDF]
Please note that on Windows, Prince can be called from the command-line by
running the prince.exe file found in the
Prince\engine\bin folder of the Prince installation:
"C:\Program Files (x86)\Prince\engine\bin\prince.exe" OPTIONS
FILES
[-o PDF]
prince file.xml
file.xml to
file.pdf.
prince doc.html
-o out.pdf
doc.html to
out.pdf.
prince http://example.com
-o out.pdf
http://example.com webpage to
out.pdf.
Note that it is necessary to specify the output file when the input is a
HTTP or HTTPS URL.
prince
-s style1.css
-s style2.css
input.xml
-o output.pdf
input.xml to
output.pdf,
applying two user style sheets.
prince
doc1.html
doc2.html
-o out.pdf
doc1.html
and
doc2.html
into a single PDF file,
out.pdf.
prince doc.html
--raster-output=doc_%d.png
doc.html and rasterize the output
to the series of files
doc_1.png,
doc_2.png,
doc_3.png etc.
The command-line must contain the name of the input file to process. An input filename consisting of a single hyphen "-" will cause Prince to read from the standard input stream.
The output file name can be specified on the command-line using the
-o command-line option.
An output filename consisting of a single
hyphen "-" will cause Prince to write to the standard output stream.
If the output file name is omitted, the output will be placed in a file with the same name as the input, but with a PDF file extension.
It is necessary to specify the output file when the input is a HTTP or HTTPS URL.
Any of the --long command-line options can either be passed
as a single command-line argument with an equals sign (=), or as two
command-line arguments with space:
--output out.pdf
--output=out.pdf
If the value of a command-line option contains a space or other command characters, the value has to be written between quotation marks.
If rasterization is used, the -o option is optional.
If not specified, a PDF output will not be generated.
The command-line may include the options described below:
-h, --help
--version--credits-v, --verbose
--debug--log=FILE--no-warn-css-unknown--no-warn-css-unsupported--no-warn-css-i FORMAT,
--input=FORMAT
auto | xml |
html].
-l,
--input-list=FILE
--baseurl=URL
--remap=URL=DIR
Rather than retrieving documents beginning with
URL get them from the local directory
DIR.
This option can be used multiple times to specify more than one remapping.
It cannot be used with --fileroot.
Note that Prince does not know which file to use when the path maps to a
directory (in other words, an index file).
If http://www.example.com/ is requested, and mapped to
example-com it does not know whether to open
example-com/index.html,
example-com/index.php or any other file
as this is site dependent. In this case Prince will report an error for
that resource.
--fileroot=DIR
--xinclude
--input
command-line option.
--xxe,
--xml-external-entities
--no-local-files
--no-network--auth-user=USER--auth-password=PASS--auth-server=HOST[:PORT]
--auth-scheme=SCHEME
http or https
--auth-method=METHODbasic, digest, ntlm and
negotiate.
The default is basic.
--auth=URL[SCHEME:]//USER:PASS@HOST[:PORT].
Unlike the preceding
options, --auth may be used multiple times.
The username and password must be percent-encoded.
--no-auth-preemptive--http-proxy=PROXY--http-timeout=SEC--cookie=COOKIESet-Cookie HTTP header value.
--cookie may be used multiple times.
--cookiejar=FILE--ssl-cacert=FILE--ssl-capath=PATH--ssl-cert=FILE--ssl-cert-type=TYPE--ssl-key=FILE--ssl-key-type=TYPE--ssl-key-password=PASS--ssl-version=VERSIONdefault (let
libcurl
choose), tlsv1,
tlsv1.0, tlsv1.1 or tlsv1.2.
--insecure--no-parallel-downloads--javascript--script=FILE-s FILE,
--style=FILE
--media=MEDIA
--page-size=SIZE
size property in @page
rules, which can take two values for horizontal and vertical dimensions. On the
command-line it needs to be written between quotes as a single argument. See
also Page size and Page Size Keywords.
--page-margin=MARGIN
--no-author-style--no-default-style-o FILE.PDF,
--output=FILE.PDF
--pdf-lang=LANG
--pdf-profile=PROFILE
--pdf-output-intent=ICC
--attach=FILE
--no-artificial-fonts--no-embed-fonts--no-subset-fonts--no-system-fonts@font-face
rules in CSS will be available.
--force-identity-encoding--no-compress--no-object-streams--convert-colors--fallback-cmyk-profile=ICC--tagged-pdf--css-dpi--pdf-title=TITLE--pdf-subject=SUBJECT--pdf-author=AUTHOR--pdf-keywords=KEYWORDS
--pdf-creator=CREATOR--pdf-xmp=XMP--encrypt--key-bits=NUM--user-password=PASS--owner-password=PASS
--disallow-print--disallow-copy--disallow-annotate--disallow-modify
Rasterization is enabled with the --raster-output option
below.
When this is used the PDF output option (-o) is optional.
--raster-output=TEMPLATE
Enable raster output.
The output files will be named based on the template.
Prince will replace every
'%[WIDTH]d'
with the current page number.
The optional WIDTH value gives the
number of characters the page number should take within the file name.
Smaller page numbers will be padded to the left with either spaces,
or if the width begins with a zero, with zeros.
For example --raster-output=page_%02d.png will cause
Prince to generate
page_01.png,
page_02.png, …,
page_10.png,
page_11.png etc.
Prince also accepts `-' meaning the standard output
stream.
--raster-format=FORMAT
auto (guess based on file extension, the default),
png or jpeg.
If Prince does not recognize the file extension, or
--raster-output is '-',
then it is necessary to provide this option.
--raster-pages=PAGE
all (the default),
first and
NUM (a single page).
--raster-dpi=DPI
--raster-threads=NUM
--raster-background=BACKGROUND
transparent or
white. It can be used when rasterizing to an
image format that supports transparency (PNG, not JPG) and have a
transparent background, so it can be composited with something else
later.
--scanfonts FILES...--capture DIR--replay DIRThe capture/replay system saves a copy of all the information in a job to a specified directory, conveniently allowing it to be replayed later for debugging purposes. See also The capture/replay system.
--controlThe Prince Control Protocol is a synchronous bidirectional protocol that consists of a sequence of "chunks" sent via the standard input and output streams. For more details, please check the detailed documentation in the separate Prince Control Protocol chapter.
--structured-log=LEVELThe Structured Log option is a formatting option for Prince's output to stderr. For more details, please check the detailed documentation in the separate Structured Log chapter.
In this section you find the documentation for supported CSS features.
Prince supports, fully or partially, the following CSS specifications:
| CSS Level 2 | |
|---|---|
| CSS 2.1 | Prince supports the specification, with few exceptions: Prince does not support
the quotes property or the open-quote and close-quote
values. Prince does not support properties that apply only to interactive media. Note
that this includes outline and its outline-* subproperties.
For similar reasons, Prince does not support visibility: collapse. Prince
does not support the armenian or georgian list styles. Prince
treats 1ex equivalently to 0.5em, which might not be correct
for some fonts. |
| CSS Level 3 | |
| CSS Backgrounds and Borders Module Level 3 | Prince does not support box-shadow and the border-image
properties. |
| CSS Fragmentation Module Level 3 | Prince does not support break-{before,after,inside}. However, Prince
supports also the Prince-specific properties column-break-{before,after}.
The initial value of widows and orphans has been changed from
2 to 1. |
| CSS Color Module Level 3 | Prince supports opacity. It supports some of the extensions of the
color property, but not hsl(). rgba() is supported
in builds after Prince 11. |
| CSS Generated Content Module Level 3 | Prince does not recognize the quotes property and the quote-related
content types. |
| CSS Fonts Module Level 3 | Beyond the definitions in CSS 2.1, only font-stretch is recognized.
However, Prince provides a different interface to the functionality of the font-variant-*
and font-feature-settings properties. |
| CSS Generated Content for Paged Media Module | Prince recognizes footnote-display and string-set as
well as the mechanism for running elements. It does not recognize the
running or footnote-policy properties, but Prince provides
a different interface to the functionality of footnotes. |
| CSS Image Values and Replaced Content Module Level 3 | Prince recognizes image-resolution, but takes a different syntax. |
| CSS Multi-column Layout Module | Prince largely supports this module. |
| CSS Overflow Module Level 3 | Prince only recognizes the overflow property from CSS 2.1. However,
it supports its behaviour as described in the Level 3 module. |
| CSS Paged Media Module Level 3 | Prince largely supports this module. |
| CSS Text Module Level 3 | Prince does not recognize line-break, text-align-all
and hanging-punctuation, and it does not support the value
break-word of the property word-break. |
| CSS Transforms Module Level 1 | Prince recognizes transform and transform-origin, but
does not recognize transform-box. Prince does not allow perspective transforms. |
| CSS Basic User Interface Module Level 3 (CSS3 UI) | Prince recognizes box-sizing and text-overflow. |
| CSS Writing Modes Level 3 | Prince partially implements writing-mode. |
| CSS Namespaces Module Level 3 | Prince supports namespaces in CSS. |
| CSS Conditional Rules Module Level 3 | Prince supports the @media
and @supports at-rules. |
| Filter Effects Module Level 1 | Prince supports the filter property. |
| CSS Level 4 | |
| CSS Flexible Box Layout Module Level 1 | Prince supports this module as of Prince 12, with the exception of page breaking/fragmentation, break-before/-after, visibility:collapse and vertical writing. |
| Selectors Level 4 | Prince largely supports this module. |
| Media Queries Level 4 | Prince supports this module as of Prince 11.1. |
| CSS Cascading and Inheritance Level 4 | Prince supports the new supports() condition for the @import rule. |
| CSS Backgrounds and Borders Module Level 4 | Prince supports the border-clip property. |
| Living Standards | |
| CSS Books | Prince supports target counters, footnote floats, bookmarks labels, levels and
states, the flow property and the string-set property. |
| CSS Figures | Prince largely supports the float extensions of the spec. |
| SVG | |
| SVG 1.1 | Prince does not support alignment-baseline, color-interpolation,
color-profile, enable-background, glyph-orientation-horizontal,
kerning, mask, pointer-events (barely applicable to Prince),
font-size-adjust, glyph-orientation-vertical. |
Prince supports the following length units:
The absolute length units correspond to exact distances in the PDF file.
| Absolute length units | |
|---|---|
cm |
centimeters |
mm |
millimeters |
q |
quarter-millimeters |
in |
inches |
pc |
picas |
pt |
points |
The font length units are relative to the font-size property.
| Font length units | |
|---|---|
em |
font size of the element |
rem |
font size of the root element |
ex |
x-height of the element's font |
The pixel unit is relative to the de-facto standard of 96dpi (or
rather, 96 pixel per inch) for compatibility with browsers.
| Pixel unit | |
|---|---|
px |
pixel |
Below are all of the CSS properties supported by Prince. For their precise definitions please refer to the CSS specifications.
* properties marked with an asterisk are Prince extensions.
For the values, the grammar follows the CSS Values and Units Module Level 3 specification. A short explanation of the signs:
align-content: flex-start | flex-end | center | space-between | space-around | stretch| Initial value | stretch |
|---|---|
| Applies to | multi-line flex containers |
| Inherited | no |
align-items: flex-start | flex-end | center | baseline | stretch| Initial value | stretch |
|---|---|
| Applies to | flex containers |
| Inherited | no |
align-self: auto | flex-start | flex-end | center | space-between | space-around| Initial value | auto |
|---|---|
| Applies to | flex items |
| Inherited | no |
alternate-color: color| Initial value | |
|---|---|
| Applies to | all elements |
| Inherited | no |
@prince-color TestColor { alternate-color: cmyk(1, 0, 0, 0) }
color: prince-color(TestColor)This property takes an RGB or CMYK color in any of the valid notations for RGB and CMYK colors, that will be used to display the color being defined, when the named color is not available. Please note that it cannot be RGBA or CMYKA.
A color value must be specified for the rule to be valid.
background:
[ background-image
|| background-position [ / background-size ]?
|| background-repeat
|| background-attachment
|| background-origin background-clip?
|| background-color ]#| Initial value | transparent |
|---|---|
| Applies to | all elements |
| Inherited | no |
The background property is a shorthand for
setting the following CSS properties:
background-attachment: scroll | fixed| Initial value | scroll |
|---|---|
| Applies to | all elements |
| Inherited | no |
The background-attachment property determines the origin
of the coordinate system for background images. The default value of
scroll will position background images based on an origin
at the top-left corner of the padding area of the current element,
while a value of fixed places the origin at the top-left
corner of the page box.
The background-attachment property only changes
the origin of the coordinate system used to position the image; the
background image will still only be shown within the padding area of
the current element.
background-color: color| Initial value | transparent |
|---|---|
| Applies to | all elements |
| Inherited | no |
background-clip: content-box | padding-box | border-box| Initial value | border-box |
|---|---|
| Applies to | all elements |
| Inherited | no |
background-image: none | url( filename ) | linear-gradient( ... ) | radial-gradient( ... ) | repeating-linear-gradient( ... ) | repeating-radial-gradient( ... )| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
background-image-resolution: dpi | normal | auto [ , normal | dpi ]?| Initial value | normal |
|---|---|
| Applies to | background image elements |
| Inherited | yes |
This property determines the resolution of a background image. The value normal
means 96dpi, or else the current CSS DPI setting. A custom DPI value can also
be specified. The value auto means to check the original resolution
of the image. One can specify a second value, as for example auto, normal
or auto, 300dpi in order to check the original resolution of the
image first, and to fall back on the second value if the image doesn't contain
resolution information.
The property prince-background-image-resolution can be used as an alias.
background-origin: content-box | padding-box | border-box| Initial value | padding-box |
|---|---|
| Applies to | all elements |
| Inherited | no |
background-position:
[ top | bottom | left | right
| center | percent | length
| [ top | bottom | center ]
[ left | right | center ]
| [ left | right | center | percent | length ]
[ top | bottom | center | percent | length ] ]#| Initial value | top left |
|---|---|
| Applies to | all elements |
| Inherited | no |
The background-position property determines the position
of the background image relative to the top-left corner of the
padding area of the element in which it appears.
The background-attachment
property can be used to change the origin relative to which the
background image is positioned.
background-repeat: repeat | repeat-x | repeat-y | no-repeat | round | space| Initial value | repeat |
|---|---|
| Applies to | all elements |
| Inherited | no |
The background-repeat property determines whether the
background image is repeated to cover the padding area of the current
element with a rectangular tiling, or only repeated horizontally or
vertically, or only drawn once and not repeated at all.
background-size: [ contain | cover | [ auto | length | percent ] {1..2} ]#| Initial value | auto auto |
|---|---|
| Applies to | all elements |
| Inherited | no |
baseline-shift: baseline | sub | super | percent | length| Initial value | baseline |
|---|---|
| Applies to | inline elements |
| Inherited | no |
The baseline-shift property only applies to SVG text elements.
bleed: auto | [ length ] {1..4}| Initial value | auto |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page { prince-bleed: 10mm }This CSS at-rule descriptor can be used to specify the size of the bleed area of the page when crop marks are enabled.
The property prince-bleed can be used as an alias.
bookmark-label: none | content| Initial value | content() |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine the text content of the PDF bookmark generated by the current element.
Several ways of creating content are here defined by means of functions - the detailed explanation can be found in the Generated Content Functions section.
Even though the initial value for this property is
content(), no PDF bookmark will be generated by default
as the initial value for the prince-bookmark-level
property is none.
See the documentation for PDF Bookmarks for more details.
The property prince-bookmark-label can be used as an alias.
bookmark-level: none | integer| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine the numeric level in the bookmark hierarchy of the PDF bookmark generated by the current element. See the documentation for PDF Bookmarks for more details.
The property prince-bookmark-level can be used as an alias.
bookmark-state: open | closed| Initial value | open |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine whether the bookmark tree item is open or closed when the PDF is first viewed. In this way you can close each chapter and hide the subsections for documents that are very long, or you can choose to have a deep bookmark tree.
The property prince-bookmark-state can be used as an alias.
bookmark-target: self | url( target-url ) | attr( target-attr )| Initial value | self |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine the link target for the PDF bookmark generated by the current element. See the documentation for PDF Bookmarks for more details.
The property prince-bookmark-target can be used as an alias.
border: color || border-style || border-width| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border property is a shorthand for
setting the following CSS properties:
border-bottom: color || border-style || border-width| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border-bottom property is a shorthand for
setting the following CSS properties:
border-bottom-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-bottom-style: none | hidden | solid | dashed | dotted | double | groove | ridge | inset | outset| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-bottom-width: thin | medium | thick | length| Initial value | medium |
|---|---|
| Applies to | all elements |
| Inherited | no |
Even though the initial value for this property is
medium, no bottom border will be shown by default as
the initial value for border-bottom-style
is none.
border-clip: normal | length| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-collapse: separate | collapse| Initial value | separate |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property determines whether tables use separate table and cell borders or collapse the table and cell borders together. See the Tables documentation for more details.
border-color: color {1..4}| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border-color property is a shorthand for
setting the following CSS properties:
border-left: color || border-style || border-width| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border-left property is a shorthand for
setting the following CSS properties:
border-left-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-left-style: none | hidden | solid | dashed | dotted | double | groove | ridge | inset | outset| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-left-width: thin | medium | thick | length| Initial value | medium |
|---|---|
| Applies to | all elements |
| Inherited | no |
Even though the initial value for this property is
medium, no left border will be shown by default as
the initial value for border-left-style
is none.
border-radius: length {1..2}| Initial value | 0 |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-bottom-left-radius: length {1..2}| Initial value | 0 |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-bottom-right-radius: length {1..2}| Initial value | 0 |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-top-left-radius: length {1..2}| Initial value | 0 |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-top-right-radius: length {1..2}| Initial value | 0 |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-right: color || border-style || border-width| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border-right property is a shorthand for
setting the following CSS properties:
border-right-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-right-style: none | hidden | solid | dashed | dotted | double | groove | ridge | inset | outset| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-right-width: thin | medium | thick | length| Initial value | medium |
|---|---|
| Applies to | all elements |
| Inherited | no |
Even though the initial value for this property is
medium, no right border will be shown by default as
the initial value for border-right-style
is none.
border-style: border-style {1..4}| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border-style property is a shorthand for
setting the following CSS properties:
border-top: color || border-style || border-width| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border-top property is a shorthand for
setting the following CSS properties:
border-top-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-top-style: none | hidden | solid | dashed | dotted | double | groove | ridge | inset | outset| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
border-top-width: thin | medium | thick | length| Initial value | medium |
|---|---|
| Applies to | all elements |
| Inherited | no |
Even though the initial value for this property is
medium, no top border will be shown by default as
the initial value for border-top-style
is none.
border-width: [ thin | medium | thick | length ] {1..4}| Initial value | medium |
|---|---|
| Applies to | all elements |
| Inherited | no |
The border-width property is a shorthand for
setting the following CSS properties:
box-decoration-break: slice | clone| Initial value | clone |
|---|---|
| Applies to | block elements and tables |
| Inherited | no |
This property is only supported on block elements and tables. Also note that
Prince defaults to clone.
box-sizing: content-box | padding-box | border-box| Initial value | content-box |
|---|---|
| Applies to | all elements |
| Inherited | no |
break-after: auto | avoid | avoid-page | avoid-column | page | left | right | recto | verso | column| Initial value | auto |
|---|---|
| Applies to | block-level elements in the normal flow of the root element |
| Inherited | no |
This property can be used to force or suppress page breaks after an element.
The values avoid-page and avoid-column each behave
as simply avoid: it is not possible to avoid page breaks without
also avoiding column breaks.
See the documentation for Page breaks for more details.
break-before: auto | avoid | avoid-page | avoid-column | page | left | right | recto | verso | column| Initial value | auto |
|---|---|
| Applies to | block-level elements in the normal flow of the root element |
| Inherited | no |
This property can be used to force or suppress page breaks before an element.
The values avoid-page and avoid-column each behave
as simply avoid: it is not possible to avoid page breaks without
also avoiding column breaks.
See the documentation for Page breaks for more details.
break-inside: auto | avoid | avoid-page | avoid-column| Initial value | auto |
|---|---|
| Applies to | block-level elements in the normal flow of the root element |
| Inherited | no |
This property can be used to suppress page breaks inside an element. See the documentation for Page breaks for more details.
caption-page: first | following | all| Initial value | first |
|---|---|
| Applies to | table elements |
| Inherited | yes |
This property determines whether table captions will be displayed on the first page of a table, or only on following pages, or repeated on every page that a table appears on.
The property prince-caption-page can be used as an alias.
caption-side: top | bottom| Initial value | top |
|---|---|
| Applies to | table-caption elements |
| Inherited | yes |
This property determines whether table captions will be displayed at the top or bottom of the table.
clear: none | left | right | inside | outside | both| Initial value | none |
|---|---|
| Applies to | block-level elements |
| Inherited | no |
This property determines whether an element should be moved down the
page in order to clear elements that have been floated to the left or
right of the page. The left, right,
inside and outside
values correspond to values given to the float
property, while both will clear floats on either side.
clip: auto | rect( offset, offset, offset, offset )| Initial value | auto |
|---|---|
| Applies to | absolutely positioned elements |
| Inherited | no |
This property determines the clipping rectangle for absolutely
positioned elements (ie. elements with a position
value of absolute or
fixed).
clip-path: none | url( path )| Initial value | none |
|---|---|
| Applies to | SVG elements |
| Inherited | no |
The clip-path property only applies to SVG elements.
clip-rule: nonzero | evenodd| Initial value | nonzero |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The clip-rule property only applies to SVG elements.
color: color| Initial value | black |
|---|---|
| Applies to | all elements |
| Inherited | yes |
See the Color section for supported color values.
column-break-after: auto | always| Initial value | auto |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
This property is deprecated. Use break-after:column
instead. See the documentation for Columns for more details.
column-break-before: auto | always| Initial value | auto |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
This property is deprecated. Use break-before:column
instead. See the documentation for Columns for more details.
column-count: auto | number| Initial value | 1 |
|---|---|
| Applies to | non-replaced block-level elements (except table elements), table cells, and inline-block elements |
| Inherited | no |
column-fill: auto | balance| Initial value | balance |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
column-gap: length | normal| Initial value | normal |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
column-rule: column-rule-color || column-rule-style || column-rule-width| Initial value | none |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
The column-rule property is a shorthand for
setting the following CSS properties:
column-rule-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
column-rule-style: none | solid | dashed | dotted | double | groove | ridge | inset | outset| Initial value | none |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
column-rule-width: thin | medium | thick | length| Initial value | medium |
|---|---|
| Applies to | multicol elements |
| Inherited | no |
Even though the initial value for this property is
medium, no column rule will be shown by default as
the initial value for column-rule-style
is none.
column-span: number | all| Initial value | 1 |
|---|---|
| Applies to | in-flow block-level elements |
| Inherited | no |
A numeric column-span will only affect column floats.
column-width: auto | width| Initial value | auto |
|---|---|
| Applies to | non-replaced block-level elements (except table elements), table cells, and inline-block elements |
| Inherited | no |
columns: column-count | column-width| Initial value | 1 |
|---|---|
| Applies to | non-replaced block-level elements (except table elements), table cells, and inline-block elements |
| Inherited | no |
The columns property is a shorthand for
setting the following CSS properties:
content: normal | flow( name, page-policy? ) | [ "string" | url( filename ) | counter( name, counter-style?, page-policy? ) | counters( name, "separator", counter-style?, page-policy? ) | target-counter( url, counter, counter-style? ) | target-counters( url, counter, "separator", counter-style? ) | target-content( url ) | leader( "..." | dotted | solid | space ) | string( ident, page-policy? ) | content( ) | prince-base-url( ) | prince-script( ident, content? ) | prince-glyph-index( number ) | prince-fallback( url ) [ , content+ ]? | element( name ) ]+| Initial value | normal |
|---|---|
| Applies to | all elements, tree-abiding pseudo-elements, and page regions |
| Inherited | no |
The content property can be used to insert text and other content
into the original document. The uses are very wide-ranging and are treated in
more depth in the Generated Content section.
Several ways of creating content are here defined by means of functions - the detailed explanation can be found in the Generated Content Functions section.
counter-increment: none | [ name number? ]+| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
For information about the use of the counter-increment
property see the documentation for Counters and Numbering.
counter-reset: none | [ name number? ]+| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
For information about the use of the counter-reset
property see the documentation for Counters and Numbering.
direction: ltr | rtl| Initial value | ltr |
|---|---|
| Applies to | all elements |
| Inherited | yes |
display: inline | block | flex | inline-flex | none | list-item | run-in | table | table-header-group | table-footer-group | table-row-group | table-row | table-cell | table-caption | table-column | table-column-group | inline-block | inline-table| Initial value | inline |
|---|---|
| Applies to | all elements |
| Inherited | no |
dominant-baseline: auto | use-script | no-change | reset-size | ideographic | alphabetic | hanging | mathematical | central | middle | text-after-edge | text-before-edge| Initial value | auto |
|---|---|
| Applies to | SVG elements |
| Inherited | no |
The dominant-baseline property only applies to SVG text elements.
empty-cells: show | hide| Initial value | show |
|---|---|
| Applies to | table-cell elements |
| Inherited | yes |
fill: none | color | url( paint-server )| Initial value | black |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The fill property only applies to SVG elements.
fill-opacity: number| Initial value | 1 |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The fill-opacity property only applies to SVG elements.
fill-rule: nonzero | evenodd| Initial value | nonzero |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The fill-rule property only applies to SVG elements.
filter: none | [ url( url ) | blur( length ) | brightness( number | percent ) | contrast( number | percent ) | drop-shadow( length {1..3}, color? ) | grayscale( number | percent ) | hue-rotate( angle ) | invert( number | percent ) | opacity( number | percent ) | saturate( number | percent ) | sepia( number | percent ) ]+| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The filter property provides graphical effects like blurring,
saturating or color shifting an element. For more details see the
Filters section.
flex: none | [ flex-grow flex-shrink? || flex-basis ]| Initial value | 1 0 auto |
|---|---|
| Applies to | flex items |
| Inherited | no |
The flex property is a shorthand for
setting the following CSS properties:
flex-basis: content | width| Initial value | auto |
|---|---|
| Applies to | flex containers |
| Inherited | no |
flex-direction: row | row-reverse | column | column-reverse| Initial value | row |
|---|---|
| Applies to | flex containers |
| Inherited | no |
flex-shrink: number| Initial value | 1 |
|---|---|
| Applies to | flex items |
| Inherited | no |
flex-wrap: nowrap | wrap | wrap-reverse| Initial value | nowrap |
|---|---|
| Applies to | flex containers |
| Inherited | no |
flex-flow: flex-direction || flex-wrap| Initial value | row nowrap |
|---|---|
| Applies to | flex containers |
| Inherited | no |
The flex-flow property is a shorthand for
setting the following CSS properties:
float:
none | left | right | inside | outside
| footnote | inline-footnote
| prince-column-footnote
| prince-column-inline-footnote
| prince-snap
| [ [ top | bottom | column-top | column-bottom
| column-top-corner | column-bottom-corner ]
&& [ next | unless-fit ]? ]| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
Traditionally, floats move in the inline direction, left or right. Prince extends this behavior with page floats that move in the block direction, specifying that an element should be floated to the top or to the bottom, or to the nearest edge of the column.
The values top or bottom float the element to, respectively,
the top or the bottom of the page.
The values column-top and column-bottom float the element
to the top or bottom of the column it appears in.
The values column-top-corner and column-bottom-corner
float the element to the top or bottom of the last column, rather than its natural
column.
The value prince-snap floats the element to the nearest "end", i.e.
to the top or bottom of the page, or of the column in the case of a multi-column
layout.
The values inside and outside float the element respectively
to the inside or outside of a spread: inside moves the element to
the right when used on a left-facing page, and to the left on a right-facing page;
outside moves the element to the left when used on a left-facing
page, and to the right on a right-facing page. When these values are used in
a multi-column layout, the element is floated to the inside or outside of the
column it appears in its natural flow.
The value footnote transforms the element into a footnote - the footnote
marker is placed outside of the block of the footnote. The value inline-footnote
transforms the element into a footnote and places the footnote marker inside of
the block of the footnote.
The values prince-column-footnote and prince-column-inline-footnote
behave in an analogous way, but move the footnote not to the bottom of the page,
but to the bottom of its column instead.
The additional modifier next defers the float to the next column in
a multi-column layout, otherwise it defers the float to the next page.
The modifier unless-fit expresses a conditional: the element is only
floated if it would otherwise cause a page or column break.
flow: normal | static( name, [ start | current ]? )| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to remove elements from the normal flow of the document and place them in a page region to create running page headers and footers. See the documentation for Page regions for more details.
The property prince-flow can be used as an alias.
font: font-style? font-variant? font-weight? font-size [ / line-height ]? font-family| Initial value | 12pt serif |
|---|---|
| Applies to | all elements |
| Inherited | yes |
font: bold 14pt/16pt Georgia, "Times New Roman", serif
The font property is a shorthand for
setting the following CSS properties:
font-family: [ serif | sans-serif | monospace | name | "name" ]# prince-no-fallback?| Initial value | serif |
|---|---|
| Applies to | all elements |
| Inherited | yes |
font-family: Georgia, "Times New Roman", serif
font-family: MyFont, prince-no-fallback
The special keyword prince-no-fallback triggers a warning if
any glyphs are not found in the specified font, whereas normally Prince
would silently fallback to serif.
When used as a descriptor for the
@font-face at-rule,
font-family defines the font family name that will be used in
all CSS font family name matching. It is required for the @font-face
rule to be valid.
font-size: length | smaller | larger | xx-small | x-small | small | medium | large | x-large | xx-large| Initial value | 12pt |
|---|---|
| Applies to | all elements |
| Inherited | yes |
font-stretch: ultra-condensed | extra-condensed | condensed | semi-condensed | normal | semi-expanded | expanded | extra-expanded | ultra-expanded | wider | narrower| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
The font-stretch property is not supported for system
fonts on Windows.
font-style: normal | italic| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
font-variant: normal | small-caps | prince-no-kerning | prince-opentype( [ feature ]+ )| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
<span style="font-family: SpecialFont; font-variant: prince-opentype(aalt(2))">&</span>
font-variant: prince-opentype(onum, ccmp, liga)
The prince-opentype() function takes a comma-separated list of
OpenType features. Microsoft has a list of the OpenType feature names
here.
Some OpenType features like aalt (access all alternates) can be
used to select one of many optional glyphs, eg. a font might provide three different
ampersand glyphs and allow the author to choose which one. An optional integer
parameter is how you do this, however it requires intimate details of exactly
which font is being used and what glyphs it provides.
The feature can be written either in function form (feature(N))
or in concatenated form (featureN).
The keyword prince-no-kerning disables the kern
OpenType feature, which defines font kerning.
font-weight: normal | bold | bolder | lighter | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
footnote-display: block | inline | compact| Initial value | block |
|---|---|
| Applies to | footnote elements |
| Inherited | no |
This property provides a convenient way of determining whether footnotes should be displayed as a block element or an inline element.
The value compact leaves it up to Prince to determine whether
to display the footnote as a block or inline element: if two or more footnotes
fit on one line, they will be treated as inline elements to take up less space.
footnote-style-position: outside | inside| Initial value | outside |
|---|---|
| Applies to | footnote elements |
| Inherited | yes |
For information about the use of the footnote-style-position
property see the documentation for Footnotes.
height: auto | length | percent| Initial value | auto |
|---|---|
| Applies to | all elements except non-replaced inline elements, table columns, and column groups |
| Inherited | no |
hyphens: none | manual | auto| Initial value | manual |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property defines if hyphenation is allowed to create more wrapping points in a line of text.
hyphenate-patterns: none | url( patterns-url )| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property is used to point to a hyphenation dictionary. Normally this is selected automatically, based on the current language.
The property prince-hyphenate-patterns can be used as an alias.
hyphenate-after: integer| Initial value | 1 |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the minimum number of letters in a word that may be moved to the next line when the word is hyphenated.
The property prince-hyphenate-after can be used as an alias.
hyphenate-before: integer| Initial value | 1 |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the minimum number of letters in a word that may be left at the end of a line when the word is hyphenated.
The property prince-hyphenate-before can be used as an alias.
hyphenate-character: auto | "string"| Initial value | auto |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the character that is shown at the end of a line when the word is hyphenated.
The property prince-hyphenate-character can be used as an alias.
hyphenate-lines: no-limit | integer| Initial value | no-limit |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the maximum number of consecutive lines that may end with a hyphenated word.
The property prince-hyphenate-limit-lines can be used as an alias.
image-resolution: dpi | normal | auto [ , normal | dpi ]?| Initial value | normal |
|---|---|
| Applies to | image elements |
| Inherited | yes |
This property determines the resolution of an image. The value normal
means 96dpi, or else the current CSS DPI setting. A custom DPI value can also
be specified. The value auto means to check the original resolution
of the image. One can specify a second value, as for example auto, normal
or auto, 300dpi in order to check the original resolution of the
image first, and to fall back on the second value if the image doesn't contain
resolution information.
The property prince-image-resolution can be used as an alias.
justify-content: flex-start | flex-end | center | space-between | space-around| Initial value | flex-start |
|---|---|
| Applies to | flex containers |
| Inherited | no |
letter-spacing: normal | length| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
line-stacking-strategy: inline-line-height | block-line-height | max-height | grid-height| Initial value | inline-line-height |
|---|---|
| Applies to | block-level elements |
| Inherited | yes |
This property allows to choose whether individual lines should have their height determined based on their content, or whether all lines in a paragraph should have the same height, or a compromise where their heights are determined by their content and then rounded up to a multiple of the paragraph line height.
The behavior define by inline-line-height is the default.
The value block-line-height uses the line-height of the block
element and ignores the actual height of the content on those lines, so lines
will always have the same spacing regardless of whether they contain spans
with larger font size of superscripts/subscripts.
The value grid-height is like inline-line-height
but each line gets rounded up to an integer multiple of the block line-height.
Finally, the max-height value works like inline-line-height,
but it ignores the line-height property value
for inline elements.
line-height: normal | none | number | length| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
link: none | url( target-url ) | attr( target-attr )| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property makes an element into a link to the specified URL.
The property prince-link can be used as an alias.
list-style: list-style-image || list-style-position || list-style-type| Initial value | outside disc |
|---|---|
| Applies to | list items |
| Inherited | yes |
The list-style property is a shorthand for
setting the following CSS properties:
list-style-type: box | check | circle | diamond | disc | hyphen | square | decimal | decimal-leading-zero | lower-roman | upper-roman | lower-alpha | lower-latin | upper-alpha | upper-latin | lower-hexadecimal | upper-hexadecimal | binary | octal | asterisks | arabic-indic | lower-greek | upper-greek | lower-norwegian | upper-norwegian | lower-russian | upper-russian | lower-ukrainian | upper-ukrainian | lower-belarusian | upper-belarusian | lower-bulgarian | upper-bulgarian | lower-serbian | upper-serbian | persian | urdu | japanese-informal | japanese-formal | cjk-decimal | simp-chinese-informal | simp-chinese-formal | trad-chinese-informal | trad-chinese-formal| Initial value | disc |
|---|---|
| Applies to | list items |
| Inherited | yes |
margin: [ auto | length | percent ] {1..4}| Initial value | 0 |
|---|---|
| Applies to | all elements, except elements with table display types other than table-caption, table and inline-table |
| Inherited | no |
The margin property is a shorthand for
setting the following CSS properties:
margin-inside: auto | length | percent| Initial value | auto |
|---|---|
| Applies to | all elements, except elements with table display types other than table-caption, table and inline-table |
| Inherited | no |
The margin-inside property overrides the value of the
margin-right property if the element is on a left-facing
page and overrides the value of the margin-left property
if the element is on a right-facing page. The result is a horizontal
margin on the side of the element that is on the "inside" of the
two-page spread.
margin-outside: auto | length | percent| Initial value | auto |
|---|---|
| Applies to | all elements, except elements with table display types other than table-caption, table and inline-table |
| Inherited | no |
The margin-outside property overrides the value of the
margin-left property if the element is on a left-facing
page and overrides the value of the margin-right property
if the element is on a right-facing page. The result is a horizontal
margin on the side of the element that is on the "outside" of the
two-page spread.
marker-start: none | url( marker-url )| Initial value | none |
|---|---|
| Applies to | SVG elements |
| Inherited |
The marker-start property only applies to SVG elements.
marker-mid: none | url( marker-url )| Initial value | none |
|---|---|
| Applies to | SVG elements |
| Inherited |
The marker-mid property only applies to SVG elements.
marker-end: none | url( marker-url )| Initial value | none |
|---|---|
| Applies to | SVG elements |
| Inherited |
The marker-end property only applies to SVG elements.
marks: none || crop || cross| Initial value | none |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page { marks: crop }@page { marks: crop cross }
This CSS at-rule descriptor, used with the
@page at-rule, adds
crop and/or cross marks to the page.
Specifying crop and/or cross for
the marks property will result in 6pt of bleed area being
added to all four sides of the page and additional trim area to
contain the crop marks.
mask: url( mask )| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The mask property is used to partially or fully hide an element
by masking it with a provided image.
max-height: none | length | percent| Initial value | none |
|---|---|
| Applies to | all elements but non-replaced inline elements, table columns, and column groups |
| Inherited | no |
max-width: none | length | percent| Initial value | none |
|---|---|
| Applies to | all elements but non-replaced inline elements, table rows, and row groups |
| Inherited | no |
min-height: auto | length | percent| Initial value | 0 |
|---|---|
| Applies to | all elements but non-replaced inline elements, table columns, and column groups |
| Inherited | no |
min-width: auto | length | percent| Initial value | 0 |
|---|---|
| Applies to | all elements but non-replaced inline elements, table rows, and row groups |
| Inherited | no |
opacity: number| Initial value | 1 |
|---|---|
| Applies to | all elements |
| Inherited | no |
Opacity is a number between 0 and 1.
order: integer| Initial value | 0 |
|---|---|
| Applies to | flex items and absolutely-positioned children of flex containers |
| Inherited | no |
orphans: integer| Initial value | 1 |
|---|---|
| Applies to | block container elements |
| Inherited | yes |
If a paragraph is split over two pages or columns, this property determines the minimum number of lines that must be left at the bottom of the first page or column.
overflow: visible | hidden| Initial value | visible |
|---|---|
| Applies to | non-replaced block-level elements and non-replaced inline-block elements |
| Inherited | no |
This property determines the visibility of content that overflows outside the boundaries of an element.
overflow-wrap: normal | break-word| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
part { overflow-wrap: break-word; }
supplier, item { overflow-wrap: normal; }
<part><supplier>xyz</supplier><item>12345</item></part>This property controls wrapping behavior of last resort:
whether it is better for a word to overflow its container,
or to be broken at an arbitrary point
(subject to white-space, and not splitting within a grapheme cluster),
without adding a hyphen.
The value normal allows text containing no other wrap
opportunities to overflow.
This feature is most commonly used for non-words such as URIs, part codes,
or cryptographic hashes.
For such purposes, overflow-wrap:break-word can be
compared with word-break:break-all:
the latter is more willing to break the word (preferring to break
than to leave an under-full line or advance past a CSS2-style float),
but only breaks between alpha-numeric grapheme clusters rather than
between any pair of grapheme clusters.
The element whose overflow-wrap property controls
whether such a wrap opportunity exists at a given boundary
is the closest ancestor that “strictly contains” the boundary,
i.e. that contains text from both sides of the boundary.
Thus, components of a wrappable string can be kept on one line
by styling each component with overflow-wrap:normal
even if two components are directly adjacent to each other, as
seen in the above example.
padding: [ length | percent ] {1..4}| Initial value | 0 |
|---|---|
| Applies to | all elements, except table-row-group, table-header-group, table-footer-group, table-row, table-column-group and table-column |
| Inherited | no |
The padding property is a shorthand for
setting the following CSS properties:
page: auto | name| Initial value | auto |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property determines which named page, if any, the current element should be placed on. See the documentation for Selecting pages for more details.
page-break-after: auto | always | avoid | left | right | verso | recto| Initial value | auto |
|---|---|
| Applies to | block-level elements in the normal flow of the root element |
| Inherited | no |
This property can be used to force or suppress page breaks after an
element. Prince expands the property with the values verso and
recto.
This property is deprecated. Use the property break-after
instead. See the documentation for Page breaks for more details.
page-break-before: auto | always | avoid | left | right | verso | recto| Initial value | auto |
|---|---|
| Applies to | block-level elements in the normal flow of the root element |
| Inherited | no |
This property can be used to force or suppress page breaks before an
element. Prince expands the property with the values verso and
recto.
This property is deprecated. Use the property break-before
instead. See the documentation for Page breaks for more details.
page-break-inside: auto | avoid| Initial value | auto |
|---|---|
| Applies to | block-level elements in the normal flow of the root element |
| Inherited | no |
This property can be used to suppress page breaks inside an element.
This property is deprecated. Use the property break-inside
instead. See the documentation for Page breaks for more details.
position: static | relative | absolute | fixed | running( name )| Initial value | static |
|---|---|
| Applies to | all elements |
| Inherited | no |
The running() function removes the element from the normal document
flow and makes it available to be placed in a page region with the
element() function of the content
property. See also Taking elements from the document.
prince-background-image-resolution: dpi | normal | auto [ , normal | dpi ]?| Initial value | normal |
|---|---|
| Applies to | background image elements |
| Inherited | yes |
This property determines the resolution of a background image. The value normal
means 96dpi, or else the current CSS DPI setting. A custom DPI value can also
be specified. The value auto means to check the original resolution
of the image. One can specify a second value, as for example auto, normal
or auto, 300dpi in order to check the original resolution of the
image first, and to fall back on the second value if the image doesn't contain
resolution information.
The property background-image-resolution can be used as an alias.
prince-bleed: auto | [ length ] {1..4}| Initial value | auto |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page { prince-bleed: 10mm }This CSS at-rule descriptor can be used to specify the size of the bleed area of the page when crop marks are enabled.
The property bleed can be used as an alias.
prince-bookmark-label: none | content| Initial value | content() |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine the text content of the PDF bookmark generated by the current element.
Several ways of creating content are here defined by means of functions - the detailed explanation can be found in the Generated Content Functions section.
Even though the initial value for this property is
content(), no PDF bookmark will be generated by default
as the initial value for the prince-bookmark-level
property is none.
See the documentation for PDF Bookmarks for more details.
The property bookmark-label can be used as an alias.
prince-bookmark-level: none | integer| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine the numeric level in the bookmark hierarchy of the PDF bookmark generated by the current element. See the documentation for PDF Bookmarks for more details.
The property bookmark-level can be used as an alias.
prince-bookmark-state: open | closed| Initial value | open |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine whether the bookmark tree item is open or closed when the PDF is first viewed. In this way you can close each chapter and hide the subsections for documents that are very long, or you can choose to have a deep bookmark tree.
The property bookmark-state can be used as an alias.
prince-bookmark-target: self | url( target-url ) | attr( target-attr )| Initial value | self |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to determine the link target for the PDF bookmark generated by the current element. See the documentation for PDF Bookmarks for more details.
The property bookmark-target can be used as an alias.
prince-caption-page: first | following | all| Initial value | first |
|---|---|
| Applies to | table elements |
| Inherited | yes |
This property determines whether table captions will be displayed on the first page of a table, or only on following pages, or repeated on every page that a table appears on.
The property caption-page can be used as an alias.
prince-fallback-cmyk-profile: url( filename )| Initial value | |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-output-intent: url("AdobeRGB1998.icc");
prince-fallback-cmyk-profile: url("ISOcoated_v2_eci.icc");
}
This property is used inside a
@prince-pdf
at-rule to determine a fallback CMYK profile to be used for uncalibrated
(untagged) CMYK colors or images, if it is not possible to use the output
intent ICC profile (see prince-pdf-output-intent).
CMYK colors are treated as uncalibrated in either of the following three cases: conversion of an untagged CMYK image to another color space, conversion of a device dependent CMYK color, or when a PDF Profile requires that only device independent color is present, in which case both untagged CMYK images and device dependent CMYK colors are treated as uncalibrated CMYK colors.
prince-filter-resolution: dpi| Initial value | 96dpi |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
This property is used inside a
@prince-pdf
at-rule to specify the resolution used when rasterizing to images for
applying CSS and SVG filters. It affects all filters in the document.
prince-flow: normal | static( name, [ start | current ]? )| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property is used to remove elements from the normal flow of the document and place them in a page region to create running page headers and footers. See the documentation for Page regions for more details.
The property flow can be used as an alias.
prince-footnote-policy: auto | keep-with-line | keep-with-block| Initial value | auto |
|---|---|
| Applies to | footnote elements |
| Inherited | yes |
This property determines whether a footnote should always be displayed on the
same page as its footnote call is located on, or whether it may slip to the next
page. The value keep-with-line instructs Prince to keep the footnote
on the same page as the line with the footnote call, while keep-with-block
tells Prince to keep it together with the whole paragraph with the footnote call.
The property must be applied to the paragraph in which the footnote occurs, not to the footnote element itself.
prince-forced-breaks: short | full| Initial value | short |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property controls whether a line ended by a “preserved newline”
(such as introduced by <br>)
should preferably appear to be a normal full line (as if ended only by normal line wrapping),
or whether being shorter than a normal full line is actually preferable,
for example to mark a deliberate break.
The difference is particularly marked in justified text,
where lines ended by prince-forced-breaks:full are subject to
justification like most other lines.
(Limitation: At the time of writing, this property only affects justified text.)
This property only applies to Prince for Books.
prince-hyphenate-patterns: none | url( patterns-url )| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property is used to point to a hyphenation dictionary. Normally this is selected automatically, based on the current language.
The property hyphenate-patterns can be used as an alias.
prince-hyphenate-after: integer| Initial value | 1 |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the minimum number of letters in a word that may be moved to the next line when the word is hyphenated.
The property hyphenate-after can be used as an alias.
prince-hyphenate-before: integer| Initial value | 1 |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the minimum number of letters in a word that may be left at the end of a line when the word is hyphenated.
The property hyphenate-before can be used as an alias.
prince-hyphenate-character: auto | "string"| Initial value | auto |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the character that is shown at the end of a line when the word is hyphenated.
The property hyphenate-character can be used as an alias.
prince-hyphenate-limit-lines: no-limit | integer| Initial value | no-limit |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the maximum number of consecutive lines that may end with a hyphenated word.
The property hyphenate-lines can be used as an alias.
prince-hyphenate-lines: no-limit | integer| Initial value | no-limit |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property specifies the maximum number of consecutive lines that may end with a hyphenated word.
The property prince-hyphenate-limit-lines can be used as an alias.
prince-image-resolution: dpi | normal | auto [ , normal | dpi ]?| Initial value | normal |
|---|---|
| Applies to | image elements |
| Inherited | yes |
This property determines the resolution of an image. The value normal
means 96dpi, or else the current CSS DPI setting. A custom DPI value can also
be specified. The value auto means to check the original resolution
of the image. One can specify a second value, as for example auto, normal
or auto, 300dpi in order to check the original resolution of the
image first, and to fall back on the second value if the image doesn't contain
resolution information.
The property image-resolution can be used as an alias.
prince-image-magic: none | snap-to-integer-coords | ignore-icc-profile | jpeg-verbatim | convert-to-jpeg( percent ) | recompress-jpeg( percent )| Initial value | none |
|---|---|
| Applies to | image elements |
| Inherited | yes |
This property performs various image-related, Prince-specific tasks that do not fit into other existing CSS properties. It applies magic to images!
The snap-to-integer-coords value can be used to avoid blurring of
images in some PDF viewers.
When recompress-jpeg is specified for this property, Prince will
recompress JPEG images to save space when embedding them in the PDF
output.
The ignore-icc-profile value causes Prince to ignore any ICC color
profile embedded in the image.
The jpeg-verbatim value inhibits the normal stripping that Prince
performs, where unnecessary metadata is removed from JPEG images when they are
embedded in the PDF file.
The convert-to-jpeg(quality%) value converts non-JPEG images to JPEG,
so that they take less space (but may look blurry).
prince-linebreak-magic: none | auto| Initial value | auto |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property enables line-breaking in certain situations even in the absence of whitespace. For example, after slashes in long URLs. It can be disabled for situations in which more precise control over line-breaking behavior is preferred.
prince-line-break-choices: body | heading | title | body-lookahead | heading-lookahead | title-lookahead | fast| Initial value | body |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property is used for fine tuning the line breaking approach.
The keyword title is intended for title pages of books or
chapters, where phrasing considerations are of prime consideration even
at the cost of extremely unbalanced lines.
The keyword heading, on the other hand, is closer to
body, differing mainly in that it's less likely to hyphenate,
and is more willing to make the first line(s) a little shorter if doing so
avoids a short last line.
The *-lookahead keywords enable paragraph-at-a-time line-breaking
for the paragraph in a non-justified paragraph: choosing where to end the line
not just based on what seems best for the current line, but also considering
the effect on future lines.
The keyword fast can be used for quick web-browers–style line
breaking, useful for testing the effect of styling changes that don't depend
on good line breaking.
For more details, please see Line breaking.
This property only applies to Prince for Books.
The property prince-text-wrap can be used as an alias.
prince-mark-length: length| Initial value | 24pt |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page { prince-mark-length: 2cm }This CSS at-rule descriptor can be used to specify the length of crop marks, beginning after the offset from the page area and extending towards the edge of the paper.
prince-mark-offset: auto | [ length ] {1..4}| Initial value | auto |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page { prince-mark-offset: 6pt }This CSS at-rule descriptor can be used to specify the offset between crop and cross marks and the page area.
prince-mark-width: width| Initial value | 0.1pt |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page { prince-mark-width: 1pt }This CSS at-rule descriptor can be used to specify the line width of the crop and cross marks.
prince-n-lines: auto | integer? [ longer | shorter ] | change | integer| Initial value | auto |
|---|---|
| Applies to | "paragraphs": block container boxes that establish inline formatting contexts |
| Inherited | no |
This property is for use in the pagination phase of typesetting, for ensuring that page ends are even while avoiding widows and other awkward breaks.
Values other than the initial value of auto request that the
paragraph occupy the given number of lines; where values other than a simple
integer are relative to the number of lines that the paragraph would have
occupied if this property still had its initial value (auto).
The value change means to make the paragraph either a line
longer or shorter, whichever will be deemed to look better. This value is
provided for the common case that a page break opportunity exists both at a
line earlier and at a line later than where the page end would naturally
fall, as would typically be the case if the only relevant restriction arises
from widows:2 or orphans:2 or a minor heading that
occupies two body lines worth of height. Thus, this tends to be the most
commonly used value for this property, other than leaving at its initial
value.
A simple integer value is the least convenient value to use (since choosing the desired number requires counting the existing number of lines, and since this property is most commonly used on long paragraphs). Its value lies in the fact that the result is not subject to variation in "the number of lines that the paragraph would otherwise have had", as can occur if this paragraph spans a page end, and a subsequent styling change causes some earlier content to change in size, affecting what is the last line before the break, and if this in turn affects line-breaking decisions made to avoid having a hyphenation at the end of a page.
This property only applies to Prince for Books.
prince-page-group: start | auto| Initial value | auto |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property determines whether the first page of this element matches the :first page class selector.
prince-pdf-color-conversion: none | full| Initial value | none |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited | no |
This property may be used inside the
@prince-pdf
at-rule to convert the colors of the PDF to the output intent color space.
It functions like the --convert-colors command-line option.
prince-pdf-color-options: auto | use-true-black | use-rich-black| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited | no |
@prince-pdf {
prince-pdf-color-options: use-rich-black;
}This property may be used to control the encoding of RGB blacks and grays:
when use-true-black is used, they are encoded in the /DeviceGray colorspace
in the PDF, instead of /DeviceRGB, whereas use-rich-black disables this behavior
and keeps all the colors in RGB. Currently, auto is equivalent to use-true-black.
prince-pdf-destination: none | "name" | attr( attr )| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property may be used to create "named destinations" in generated PDF files which can be linked to from other documents.
prince-pdf-duplex: auto | simplex | duplex-flip-short-edge | duplex-flip-long-edge| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited | no |
This property may be used inside the
@prince-pdf
at-rule to set the Duplex property in the
PDFViewerPreferences dictionary.
prince-pdf-link-type: auto | web | file| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited | no |
This property controls whether relative links should be embedded in the PDF as web (URL) links or file links. By default they will be resolved against the base URL of the input document.
prince-pdf-open-action: none | [ print | command( ident ) | zoom( fit-page | fit-width | fit-height | percent ) ]+| Initial value | none |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-open-action: zoom(fit-page) print;
}This property specifies a space-separated list of actions to perform when the PDF file is opened, like eg. popping up the print dialog box automatically, or setting the default zoom level for PDF documents. Any arbitrary identifier can be specified, although these may be PDF viewer specific; Acrobat can take just about any menu item.
prince-pdf-output-intent: auto | url( filename )| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-output-intent: url("ISOcoated_v2_eci.icc")
}
This property is used inside a @prince-pdf
at-rule to select the intended output color space of the generated PDF file.
prince-pdf-page-colorspace: auto | none | rgb | cmyk | gray| Initial value | auto |
|---|---|
| Applies to | @page at-rule |
| Inherited | no |
@page {
prince-pdf-page-colorspace: cmyk;
}
This CSS at-rule descriptor can control the colorspace of pages in the PDF file, which affects
blending of transparent content. The keyword auto is currently equivalent
of rgb.
prince-pdf-page-label: auto | content| Initial value | auto |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page {
prince-pdf-page-label: counter(page, lower-roman)
}This CSS at-rule descriptor can be used to set the page label that will be displayed in the PDF viewer.
Several ways of creating content are here defined by means of functions - the detailed explanation can be found in the Generated Content Functions section.
prince-pdf-page-layout: auto | single-page | one-column | two-column | two-column-left | two-column-right| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-page-layout: two-column
}This property can be used to set the default page layout for the PDF file when it is opened. For example, whether the PDF pages should be displayed in one or two columns.
prince-pdf-page-mode: auto | show-attachments | show-bookmarks | fullscreen| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-page-mode: show-bookmarks
}This property can be used to set the default page mode for the PDF file when it is opened. For example, whether the bookmarks panel should be displayed, and whether the viewer should be fullscreen.
prince-pdf-paper-tray: auto | pick-tray-by-pdf-size| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-paper-tray: pick-tray-by-pdf-size
}This property controls the PickTrayByPDFSize flag in generated PDF files, which specifies whether the PDF page size is used to select the input paper tray. (See the checkbox in the Acrobat print dialog).
prince-pdf-print-scaling: auto | none| Initial value | auto |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-print-scaling: none
}This property can be used to disable print scaling for the PDF file when it is printed.
prince-pdf-profile: none | "Profile"| Initial value | none |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-profile: "PDF/X-3:2003"
}PDF Profiles are used to optimize the PDF file for its specific use - for more details and the supported PDF profiles, see PDF Versions and Profiles.
prince-pdf-script: "JavaScript"| Initial value | "" |
|---|---|
| Applies to | @prince-pdf at-rule |
| Inherited |
@prince-pdf {
prince-pdf-script: "this.print();"
}This property can be used to include JavaScript code that will be executed when the PDF file is opened. A common use case is to activate the "Print" dialog automatically.
prince-pdf-xmp: url( filename )| Initial value | "" |
|---|---|
| Applies to | |
| Inherited |
@prince-pdf {
prince-pdf-xmp: url("xmp-file.xmp");
}
This property can be used inside a @prince-pdf
rule to add XMP metadata to a PDF file. Currently it takes an XMP
file as input and includes data from the <x:xmpmeta> element
and its contents (the xpacket processing instructions are ignored, as
Prince generates those itself when it produces the PDF file).
This property requires either a URL pointing to an XMP
file, or an encoded data: URL.
prince-rotate-body: portrait | landscape | angle| Initial value | 0deg |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page {
prince-rotate-body: landscape
}This CSS at-rule descriptor can be used to rotate the page body, eg. to fit landscape content on a portrait page, while leaving the headers and footers where they are.
Please see the size property for determining
the default orientation of the page.
prince-shrink-to-fit: none | auto| Initial value | none |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page {
prince-shrink-to-fit: auto
}
Specifying a value of auto will result in wide web pages being scaled
down in size to fit the paper width.
prince-text-justify: auto | prince-cjk| Initial value | auto |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property defines how to treat justified text. The value prince-cjk
allows space to be inserted between CJK characters when justifying even if there
aren't any space characters.
prince-text-replace: none | [ "search" "replace" ]+| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
body {
prince-text-replace: "s" "\017F"
"\017F\20" "s\20";
}This property can be used to replace a character string with another one. In the above example, all occurrences of "s" are replaced with the "long s", except if in the end of a word, where the replacement is reversed.
prince-text-wrap: body | heading | title | body-lookahead | heading-lookahead | title-lookahead | fast| Initial value | body |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property is used for fine tuning the line breaking approach.
The keyword title is intended for title pages of books or
chapters, where phrasing considerations are of prime consideration even
at the cost of extremely unbalanced lines.
The keyword heading, on the other hand, is closer to
body, differing mainly in that it's less likely to hyphenate,
and is more willing to make the first line(s) a little shorter if doing so
avoids a short last line.
The *-lookahead keywords enable paragraph-at-a-time line-breaking
for the paragraph in a non-justified paragraph: choosing where to end the line
not just based on what seems best for the current line, but also considering
the effect on future lines.
The keyword fast can be used for quick web-browers–style line
breaking, useful for testing the effect of styling changes that don't depend
on good line breaking.
For more details, please see Line breaking.
This property only applies to Prince for Books.
The property prince-line-break-choices can be used as an alias.
prince-tooltip: transparent | none | normal | content| Initial value | transparent |
|---|---|
| Applies to | all elements |
| Inherited | no |
*[title] {
prince-tooltip: attr(title)
}
The prince-tooltip property can be used to create a tooltip when
hovering an element in the PDF file. The keyword none actually
"suppresses" tooltips, which means that it will not show any tooltip for
objects underneath the selected element, that might have a tooltip. An empty
string, or some content that evaluates to an empty string, is treated
equivalent to none, rather than showing an empty tooltip.
Several ways of creating content are here defined by means of functions - the detailed explanation can be found in the Generated Content Functions section.
Tooltips are not a standard PDF feature, and they may only work in Adobe Reader and Adobe Acrobat and may not be visible in other PDF viewers, such as web browsers.
prince-trim: auto | [ length ] {1..4}| Initial value | auto |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page {
prince-trim: 60mm
}This CSS at-rule descriptor can be used to specify the size of the trim area of the page when crop marks are enabled.
prince-wrap-inside: auto | phrase | avoid| Initial value | auto |
|---|---|
| Applies to | all elements |
| Inherited | no |
prince-wrap-inside:phrase is for marking up a phrase
that one would weakly prefer to keep on a single line.
It adds to Prince's perceived cost of breaking within that phrase, but only a small cost, comparable to the cost of hyphenating a compound adjective such as ‘midyear’.
prince-wrap-inside:avoid is a stronger directive:
it avoids breaking the text to which the property is applied even if
it causes the affected text to be unusually tight, or the previous
line to be unusually loose;
but not if either line would become truly exceptionally tightly
or loosely spaced.
(Limitation: At the time of writing, prince-wrap-inside only affects justified text.)
This property only applies to Prince for Books.
size: paper-size | length length [ landscape | portrait ]?| Initial value | Letter |
|---|---|
| Applies to | @page at-rule |
| Inherited |
@page { size: A4 }@page { size: A4 landscape }@page { size: Letter }@page { size: 10cm 5cm }
This CSS at-rule descriptor, used with the
@page at-rule, defines
the size and orientation of the page. Please see also the
prince-rotate-body property to control the
orientation of selected pages.
src: [ url( filename ) [ format( [ "format" ]+ ) ]? | local( name ) | prince-lookup( name ) ]+| Initial value | n/a |
|---|---|
| Applies to | @font-face at-rule |
| Inherited |
@font-face {
font-family: MyFontA;
src: local("Local_Font_A");
}
@font-face {
font-family: MyFontB;
src: prince-lookup("MyFontA");
}
This CSS at-rule descriptor, used with the
@font-face at-rule,
specifies the resource containing font data. It is required for the @font-face
rule to be valid.
Prince supports WOFF (Web Open Font Format), TrueType and OpenType font formats,
expressed respectively by the woff, truetype and
opentype format hints with the optional format()
function.
The local() function searches for locally installed system
fonts, while prince-lookup() will also find fonts defined by
other @font-face rules.
stop-opacity: number| Initial value | 1 |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stop-opacity property only applies to SVG elements.
string-set: none | [ ident content ]+| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
This property can be used to create a named string, which may then be referenced
from the content property to create generated
content. Typically this is achieved with the content() function,
which retrieves the text of the selected element.
But any other means of generating content, as described in the Generated Content Functions section, are available. See also Page regions for more details.
stroke: none | color | url( paint-server )| Initial value | none |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke property only applies to SVG elements.
stroke-dasharray: none | [ length | percent ]+| Initial value | none |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke-dasharray property only applies to SVG elements. It
takes a comma or
whitespace separated list of lengths or percentages as argument.
stroke-dashoffset: length | percent| Initial value | 0 |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke-dashoffset property only applies to SVG elements.
stroke-linecap: butt | round | square| Initial value | butt |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke-linecap property only applies to SVG elements.
stroke-linejoin: miter | round | bevel| Initial value | miter |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke-linejoin property only applies to SVG elements.
stroke-miterlimit: number| Initial value | 4 |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke-miterlimit property only applies to SVG elements.
stroke-opacity: number| Initial value | 1 |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke-opacity property only applies to SVG elements.
stroke-width: length | percent | length| Initial value | 1 |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The stroke-width property only applies to SVG elements.
table-baseline: number| Initial value | 1 |
|---|---|
| Applies to | table and inline-table elements |
| Inherited | no |
table-column-span: number | attr( colspan )| Initial value | 1 |
|---|---|
| Applies to | table cells |
| Inherited | no |
This property applies to table cells and determines the number of table columns spanned by the table cell. See the Tables documentation for more details.
table-row-span: number | attr( rowspan )| Initial value | 1 |
|---|---|
| Applies to | table cells |
| Inherited | no |
This property applies to table cells and determines the number of table rows spanned by the table cell. See the Tables documentation for more details.
tab-size: number | length| Initial value | 8 |
|---|---|
| Applies to | block containers |
| Inherited | yes |
This property determines the tab-size for preserved tab characters (U+0009). An integer defines number of spaces in a tab, a length represents the width of a tab.
text-align: left | right | inside | outside | center | justify| Initial value | left |
|---|---|
| Applies to | block containers |
| Inherited | yes |
text-align-last: left | right | inside | outside | center | justify| Initial value | left |
|---|---|
| Applies to | block containers |
| Inherited | yes |
This property allows the last line of an element to receive its own alignment style.
text-anchor: start | middle | end| Initial value | start |
|---|---|
| Applies to | SVG elements |
| Inherited | yes |
The text-anchor property only applies to SVG text elements.
text-decoration: none || underline || overline || line-through| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The text-decoration property is a shorthand for
setting the following CSS properties:
text-indent: length hanging?| Initial value | 0 |
|---|---|
| Applies to | block containers |
| Inherited | yes |
This property determines the indentation of the first line of text in
the element. If the hanging keyword is added after the
length, a hanging indent will be created by applying the
indentation to every line of text but the first.
text-line-through: color || text-line-through-style| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The text-line-through property is a shorthand for
setting the following CSS properties:
text-line-through-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
text-line-through-style: none | solid | dashed | dotted| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
text-overflow: clip | ellipsis| Initial value | clip |
|---|---|
| Applies to | block container elements |
| Inherited | no |
text-overline: color || text-overline-style| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The text-overline property is a shorthand for
setting the following CSS properties:
text-overline-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
text-overline-style: none | solid | dashed | dotted| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
text-transform: none | lowercase | uppercase | capitalize| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | yes |
text-underline: color || text-underline-style| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
The text-underline property is a shorthand for
setting the following CSS properties:
text-underline-color: color| Initial value | CurrentColor |
|---|---|
| Applies to | all elements |
| Inherited | no |
text-underline-style: none | solid | dashed | dotted| Initial value | none |
|---|---|
| Applies to | all elements |
| Inherited | no |
transform: none | [ rotate( angle ) | translate( offset, offset? ) | translatex( offset ) | translatey( offset ) | translate3d( offset, offset, offset ) | scale( number, number? ) | scalex( number ) | scaley( number ) | skewx( angle ) | skewy( angle ) ]+| Initial value | none |
|---|---|
| Applies to | transformable elements |
| Inherited | no |
Please note that the function translate3d() is supported if the
Z (third) coordinate is zero, thus making it equivalent to the 2D translate().
Also note that this property currently does not affect SVG elements - they
need to use their own transform attribute instead.
transform-origin: [ center | left | right | top | bottom | percent | length ] {1..2}| Initial value | 50% 50% |
|---|---|
| Applies to | transformable elements |
| Inherited | no |
If only one term is given, then the second is assumed to be center.
In particular, if only a percentage or length is given, then it is assumed to be the
horizontal coordinate.
Either one or two coordinates can be given, and if both values are given
as keywords, order doesn't matter; but if two coordinates are given and either
coordinate is a length or percentage, then the horizontal component must come
first: so top 50% is not valid, but top and
top center and 50% top are all valid and equivalent.
unicode-bidi: normal | embed | bidi-override| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | no |
unicode-range: urange+| Initial value | U+0-10FFFF |
|---|---|
| Applies to | @font-face at-rule |
| Inherited |
@font-face {
unicode-range: U+0025-00FF;
}
This CSS at-rule descriptor, used with the
@font-face at-rule,
defines the set of Unicode codepoints that may be supported by the font face
for which it is declared. The descriptor value is a comma-delimited list of
Unicode range (<urange>) values. The union of these ranges defines the
set of codepoints that serves as a hint for user agents when deciding whether
or not to download a font resource needed for the test content of a particular
page.
vertical-align: baseline | sub | super | top | text-top | middle | bottom | text-bottom | length | percent| Initial value | baseline |
|---|---|
| Applies to | inline-level and table-cell elements |
| Inherited | no |
visibility: visible | hidden| Initial value | visible |
|---|---|
| Applies to | all elements |
| Inherited | yes |
This property can be used to make the content of an element invisible.
Unlike using display: none, the element will
still take up space on the page and its descendants may still have
visible content.
white-space: normal | pre | pre-wrap | pre-line | nowrap| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
widows: integer | percent| Initial value | 1 |
|---|---|
| Applies to | block container elements |
| Inherited | yes |
If a paragraph is split over two pages or columns, this property determines the minimum number of lines that must be left at the top of the second page or column.
The percentage value only applies to Prince for Books, and indicates that one widow line is accepted, as long as the line width is at least the given percentage value of the available page width, to avoid the worst case of having a widow line that is only one or two words long.
width: auto | length | percent| Initial value | auto |
|---|---|
| Applies to | all elements but non-replaced inline elements, table rows, and row groups |
| Inherited | no |
word-break: normal | keep-all | break-all| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
Prince does not support the value break-word. Use
the value break-all or the property overflow-wrap
with the value break-word instead.
word-spacing: normal | length | percent| Initial value | normal |
|---|---|
| Applies to | all elements |
| Inherited | yes |
writing-mode: horizontal-tb | vertical-rl| Initial value | horizontal-tb |
|---|---|
| Applies to | all elements except table row groups, table column groups, table rows, and table columns |
| Inherited | yes |
Below are the CSS selectors supported by Prince. For their precise definition please refer to the CSS specification - Prince largely implements Selectors Level 4.
selector |
Can refer to a simple selector, compound selector,
complex selector, or selector list. |
selector list |
A comma-separate list of selectors. |
compound selector |
A chain of simple selectors that are not separated by a combinator. |
simple selector |
Either a type selector, universal selector, attribute selector, class selector, ID selector, or pseudo-class. |
relative selector |
A shorthand for selectors that represent elements relative to a :scope
element. |
combinator |
Punctuation that represents a particular kind of relationship between compound selectors on either side. |
An+B |
This micro-syntax to indicate indexes in a list of sibling elements represents
an integer step (A) and offset (B), i.e. it indicates the
An+Bth elements in a list. It also takes the keywords odd
and even. |
expanded element name |
The tuple of local element name and namespace name. |
| Selector List | |
|---|---|
E, F, G |
A comma-separated list of selectors represents all the elements selected by each selector of the list. |
| The Matches-Any Pseudo-class | |
E:matches(s1, s2) |
The matches-any pseudo-class represents an element E that is
represented by the list of compound selectors it takes as argument. |
| The Negation Pseudo-class | |
E:not(s1, s2) |
The negation pseudo-class represents an element E that is not
represented by the list of compound selectors it takes as argument. |
| The Relational Pseudo-class | |
E:has(rs1, rs2) |
The relational pseudo-class represents an element E, if either
of the relative selectors rs1 or rs2, when evaluated
with E as the :scope element, match an element. |
| The Contains Pseudo-class | |
E:contains(foo) |
The contains pseudo-class represents an element E containing the
text foo. |
| Type (tag name) selectors | |
|---|---|
E |
A type selector representing an element E in the default namespace. |
|E |
A type selector representing an element E in no namespace. |
ns|E |
A type selector representing an element E in the namespace ns. |
*|E |
A type selector representing an element E in any or no namespace. |
| Universal selectors | |
* |
A universal selector representing all elements in the default namespace. |
|* |
A universal selector representing all elements in no namespace. |
ns|* |
A type selector representing all elements in the namespace ns. |
*|* |
A type selector representing all elements. |
Case-sensitivity of the attributes and values depends on the document language.
To match values case-insensitively, the attribute selector may contain the identifier
i before the closing bracket. (Example: [att=val i])
Default namespaces do not apply to attributes. Therefore a namespace ns
that has been previously declared should be added before the namespace separator
| preceding the attribute name.
| Attribute presence and value selectors | |
|---|---|
[att] |
An attribute selector representing an element with the att attribute. |
[att=val] |
An attribute selector representing an element with the att attribute
with the value val. |
[att~=val] |
An attribute selector representing an element with the att attribute
containing the value val. |
[att|=val] |
An attribute selector representing an element with the att attribute
equal to or beginning with the value val. |
| Substring matching attribute selectors | |
[att^=val] |
An attribute selector representing an element with the att attribute
whose value begins with the prefix val. |
[att$=val] |
An attribute selector representing an element with the att attribute
whose value ends with the suffix val. |
[att*=val] |
An attribute selector representing an element with the att attribute
whose value contains val. |
| Class selectors | |
E.val |
A class selector representing an element E with a class identifier
val. |
| ID selectors | |
E#val |
An ID selector representing an element E with an ID identifier
val. |
| The language pseudo-class | |
|---|---|
E:lang(C) |
The language pseudo-class represents an element E that is in the
language C. |
| The input control states | |
|---|---|
:enabled |
The :enabled pseudo-class represents user interface elements that
are in the enabled state. |
:disabled |
The :disabled pseudo-class represents user interface elements that
are in the disabled state. |
:read-write |
The :read-write pseudo-class matches an element that is user-alterable. |
:read-only |
The :read-only pseudo-class matches an element that is not user-alterable. |
| The input value state | |
:checked |
The :checked pseudo-class represents user interface elements
such as radio and checkbox elements that are selected by the user. |
| The link pseudo-classes | |
|---|---|
E:link |
The :link pseudo-class applies to links that have not yet been visited. |
E:visited |
The :visited pseudo-class applies to visited links. |
| The contextual reference element pseudo-class | |
E:scope |
The contextual reference element pseudo-class represents an element E
being a designated contextual reference element. :scope is supported
in conjunction with :has(), meaning that :scope matches
the element that :has() is applied to. |
The :root pseudo-class |
|
|---|---|
:root |
The :root pseudo-class represents an element that is the root of
the document. In HTML 4 this is always the HTML element. |
The :empty pseudo-class |
|
:empty |
The :empty pseudo-class represents an element that has no children
at all. |
| The child-indexed pseudo-classes | |
:nth-child(An+B of S) |
The :nth-child(An+B) pseudo-class represents the An+Bth
element that matches the selector list S among its inclusive siblings. |
:nth-last-child(An+B of S) |
The :nth-last-child(An+B) pseudo-class represents the An+Bth
element that matches the selector list S among its inclusive siblings,
counting backwards from the end. |
:first-child |
The :first-child pseudo-class represents an element that is first
among its inclusive siblings. |
:last-child |
The :last-child pseudo-class represents an element that is last
among its inclusive siblings. |
:only-child |
The :only-child pseudo-class represents an element that has no siblings. |
| The typed child-indexed pseudo-classes | |
:nth-of-type(An+B) |
The :nth-of-type(An+B) pseudo-class represents the An+Bth
element with the same namespace and type among its inclusive siblings. |
:nth-last-of-type(An+B) |
The :nth-last-of-type(An+B) pseudo-class represents the An+Bth
element with the same namespace and type among its inclusive siblings, counting backwards
from the end. |
:first-of-type |
The :first-of-type pseudo-class represents an element that is the
first with a particular namespace and type among its inclusive siblings. |
:last-of-type |
The :last-of-type pseudo-class represents an element that is the
first with a particular namespace and type among its inclusive siblings, counting
backwards from the end. |
:only-of-type |
The :only-of-type pseudo-class represents an element that has no
siblings with the same namespace and type. |
| Descendant combinator | |
|---|---|
E F |
An F element descendant of an E element. |
E >> F |
|
| Child combinator | |
E > F |
An F element child of an E element. |
| Next-sibling combinator | |
E + F |
An F element immediately preceded by an E element. |
| Following-sibling combinator | |
E ~ F |
An F element preceded by an E element. |
| Generated content pseudo-elements | |
|---|---|
::before |
Represents a styleable child pseudo-element immediately before the originating element's actual content. |
::after |
Represents a styleable child pseudo-element immediately after the originating element's actual content. |
| List markers | |
::marker |
Represents the automatically generated marker box of a list item. |
The ::first-line pseudo-element |
|
|---|---|
::first-line |
Represents the content of the formatted line of the originating element. |
The ::first-letter pseudo-element |
|
::first-letter |
Represents the first typographic letter unit of the first formatted line of the originating element, if it is not preceded by other content. |
The ::footnote-call pseudo-element |
|
|---|---|
::footnote-call |
Represents the footnote calls, i.e. the anchors that refer to footnotes. |
The ::footnote-marker pseudo-element |
|
::footnote-marker |
Represents the footnote markers placed in front of the actual footnote text. |
The nth(N) selector |
|
|---|---|
nth(N) |
Represents the Nth page of the document: @page:nth(42) {...}
|
Below are all of the media queries supported by Prince. For their precise definition please refer to the Media Queries Level 4 specification.
Media queries test how Prince is configured, rather than how the document is styled. The configuration of Prince often depends on the command-line arguments passed to it.
A Media Query is a method of testing certain aspects of the user agent or device that the document is being displayed in.
The syntax consists of an optional media query modifier, an optional media type, and zero or more media features.
Several media queries can be combined into a comma separated media query list.
| Negating a media query | |
|---|---|
not |
An individual media query can be negated by prefixing it with the keyword not. |
| Hiding a media query from legacy user agents | |
only |
Prefixing a media query with the keyword only will have no effect
on the media query's result, but will be ignored by legacy user agents. |
A media type is a category of user-agent devices on which a document may be displayed.
A more fine-grained way of targeting a specific device's exclusive aspects might be to
use media features instead, or in addition. Prince defaults to the media type print.
However, note that the command-line option --media can be used to
set a media type that media queries can test against. This can be convenient if the
person running Prince knows in advance whether the PDF will be printed or viewed on
the screen, such as might be the case for slideshows, or in case one might prefer the author's idea of what screen means.
| Media types | |
|---|---|
all |
Matches all devices. |
print |
Matches printers and devices intended to reproduce or produce a printed display. |
screen |
Matches all devices that are not matched by print or speech. |
speech |
Matches screenreaders and other devices that "read out" a page. |
A media feature is a more fine-grained way of targeting a specific user-agent. Media features use the same syntax as CSS properties. However, there are some differences between the two:
and.Multiple media features may be combined into a media condition using full boolean
algebra (not, and, or).
| Media feature types | |
|---|---|
| discrete | Media features of the type "discrete" take their values from a set. |
| range | Media features of the type "range" take their values from a range. Their feature
names can be prefixed by min- or max-. |
width |
|
|---|---|
Value: length
|
Describes the width of the displayed page. |
| Type: range | |
height |
|
Value: length
|
Describes the height of the displayed page. |
| Type: range | |
aspect-ratio |
|
Value: length
|
Describes the ratio of the width to the height of the displayed page. |
| Type: range | |
orientation |
|
Value: portrait | landscape
|
Describes the width of the displayed page. |
| Type: discrete | |
resolution |
|
|---|---|
Value: resolution | infinite
|
Describes the resolution of the output device. |
| Type: range | |
scan |
|
Value: interlace | progressive
|
Describes the scanning process of the output device. This feature
is always false for Prince. |
| Type: discrete | |
grid |
|
Value: boolean
|
Describes whether the output device is grid (1) or bitmap (0). Prince
is bitmap based, and thus 0 matches. |
| Type: discrete | |
update |
|
Value: none | slow | fast |
Describes the ability of the output device to modify the appearance
of the content once it has been rendered. In Prince the layout cannot be updated, and
thus only none matches. |
| Type: discrete | |
overflow-block |
|
Value: none | scroll | optional-paged
| paged
|
Describes the behavior of the device when content overflows the initial containing block in the block axis.. |
| Type: discrete | |
overflow-inline |
|
Value: none | scroll
|
Describes the behavior of the device when content overflows the initial containing block in the inline axis.. |
| Type: discrete | |
color |
|
|---|---|
Value: integer
|
Describes the number of bits per color component of the output device.
Prince assumes 13 color bits. |
| Type: range | |
color-index |
|
Value: integer
|
Describes the number of entries in the color lookup table of the output device. |
| Type: range | |
monochrome |
|
Value: integer
|
Describes the number of bits per pixel in a monochrome framebuffer. |
| Type: range | |
color-gamut |
|
Value: srgb | p3 | rec2020
|
Describes the approximate range of colors that are supported by the output device. |
| Type: discrete | |
pointer, any-pointer
|
|
|---|---|
Value: none | coarse | fine
|
Describes the presence and accuracy of pointing devices. Prince assumes
none. |
| Type: discrete | |
hover, any-hover
|
|
Value: none | hover
|
Describes the user's ability to hover over elements on the page. Prince
assumes none. |
| Type: discrete | |
scripting |
|
|---|---|
Value: none | initial-only | enabled
|
Describes whether scripting languages, such as JavaScript, are supported.
Prince assumes none or initial-only, depending on its configuration. |
| Type: discrete | |
In this section you find the documentation for the supported CSS functional expressions. For additional details, make sure to also check the linked properties that use the functions.
* functions marked with an asterisk are Prince extensions.
| Function | Definition | Used in property |
|---|---|---|
attr( attribute-name type-or-unit? [, fallback]? ) |
Retrieves the value of an attribute of the selected element. | |
url( url ) |
Represents a URL, i.e. a pointer to a source. | |
rgb(R,G,B) |
Defines red, green and blue values of a color. | all color values |
rgba(R,G,B,A) |
Defines red, green and blue values and the alpha component of a color. | |
cmyk(C,M,Y,K[,A]) | device-cmyk(C,M,Y,K[,A])
|
Defines cyan, magenta, yellow and black values of a color, as well as the optional alpha component. | |
prince-color( colorname [, number | percentage]? , overprint? )* |
Using a spot color defined in the @prince-color
at-rule. The number or percentage defines the tint. An optional overprint
keyword instructs Prince whether to overprint the color.
|
|
prince-overprint( colorname | rgb() | cmyk() | device-cmyk() | prince-color() [, [overprint-mode-nonzero | overprint-mode-zero]]? )* |
Specifies a non-transparent color value to overprint. If no overprint mode
is given, it defaults to overprint-mode-nonzero. |
|
linear-gradient([ [ <angle> | to <side-or-corner> ] ,]? <color-stop>[, <color-stop>]+) |
Creates an image consisting of a progressive transition between two or more colors along a straight line. | background-image |
radial-gradient([ [ <shape> || <size> ] [ at <position> ]?, | at <position>, ]? <color-stop> [, <color-stop> ]+) |
Creates an image consisting of a progressive transition between two or more colors that radiate from an origin point | |
repeating-linear-gradient([ [ <angle> | to <side-or-corner> ] ,]? <color-stop> [, <color-stop>]+) |
Creates an image consisting of repeating linear gradients. | |
repeating-radial-gradient([ [ <shape> || <size> ] [ at <position> ]?, | at <position>, ]? <color-stop> [, <color-stop> ]+) |
Creates an image consisting of repeating radial gradients. | |
rect( offset, offset, offset, offset ) |
Defines a region in the form of a rectangle. | clip |
content() |
Retrieves the text content of the selected element. It can be used with several different properties. | content |
element( name, page-policy? ) |
Places an element (which has been removed from the normal flow with the
running() function) in a page region. See
Taking elements from the document. |
|
counter( name, counter-style?, page-policy? ) |
Generates a value for the innermost counter. | |
counters( name, "separator", counter-style?, page-policy? ) |
Concatenates counters on different levels. | |
target-counter( url, counter, counter-style? ) |
Retrieves the value of the innermost counter with a given name at the given URL. See Using target-counter(). | |
target-counters( url, counter, "separator", counter-style? ) |
Retrieves the value of all counters of a given name from the end of the given URL. | |
target-content( url ) |
References the text content of the linked element. See Using target-content(). | |
leader( "..." | dotted | solid | space ) |
Inserts the given string before the element - useful in tables of content. | |
string( ident, page-policy? ) |
Retrieves the value defined with the string-set
property. See Copying content from the document. |
|
repeat( string+ ) |
Used in counters as a counter-style, it defines a sequentially
repeated pattern for numbering the items.
This counter will yield the sequence "x, y, z, xx, yy, zz" etc. |
|
symbols( string+ ) |
Used in counters as a counter-style, it defines the symbols used
for numbering the items.
This counter will yield the sequence "x, y, z, 4, 5, 6" etc. |
|
prince-base-url()* |
Returns the base URL of the current document. | |
flow( name, page-policy? ) | prince-flow( name, page-policy? )* |
Inserts an element that has previously been removed with the static()
function. See Taking elements from the document. |
|
prince-script( ident [, content+]? )* |
Calls arbitrary JavaScript functions in CSS generated content. | |
prince-fallback( uri )*[, content+]? |
Inserts content fetched from another resource (like the url() function),
but also has the possibility of specifying a fallback content, in case the loading of the
URL should fail. If no comma and content items are provided, the fallback is as
if content: normal were specified.
|
|
prince-glyph-index( int )* |
Allows to choose a glyph from a font by the index of that glyph in the font.
Please note that this is very non-portable, as glyph indices are specific to individual font versions. But it is a possible escape hatch for people who need a specific glyph and don't have any other way of accessing it (by Unicode character or OpenType substitution). Usually, authors should prefer to use named OpenType features, using the
|
|
grayscale( number | percent ) |
Converts the input image to grayscale. | filter |
sepia( number | percent ) |
Converts the input image to sepia. | |
saturate( number | percent ) |
Saturates the input image. | |
hue-rotate( angle ) |
Applies a hue rotation on the input image. | |
invert( number | percent ) |
Inverts the samples in the input image. | |
opacity( number | percent ) |
Applies transparency to the input image. | |
brightness( number | percent ) |
Applies a linear multiplier to the input image, making it appear more or less bright. | |
contrast( number | percent ) |
Adjusts the contrast of the input image. | |
blur( length ) |
Applies a Gaussian blur to the input image. | |
drop-shadow( length{1..3}, color? ) |
Applies a drop shadow effect to the input image. | |
prince-opentype( [ feature ]+ )* |
Specifies a comma-separated list of OpenType features to be enabled. For details
please see the font-variant property and
OpenType Features in Prince. |
font-variant |
running( name ) |
Removes an element from the normal document flow, to make it available for use
in a page region with the element() function. See
Taking elements from the document. |
position |
recompress-jpeg( quality% )* |
Recompresses JPEG images by the indicated percentage to save space. | prince-image-magic |
convert-to-jpeg( quality% )* |
Converts non-JPEG images to JPEG. | |
static( name, [ start | current ]? )* |
Removes an element from the normal document flow, to make it available for use
with the flow() function. See Taking elements from the document. |
prince-flow |
command( ident )* |
Specifies any arbitrary command to be passed to the PDF viewer when the PDF file is opened. The user can supply values that Prince doesn't know about, but the viewer does. | prince-pdf-open-action |
format() |
Contains a comma-separated list of format strings that denote well-known font
formats.
|
src |
local() |
Searches for locally installed system fonts. | |
prince-lookup()* |
Searches for locally installed system fonts, but will also find fonts defined
by other @font-face rules. See Defining a font family. |
|
rotate( angle ) |
Rotates an element around a fixed point on the 2D plane. | transform |
matrix( number[, number]{5,5} ) |
Describes a homogeneous 2D transformation matrix. | |
translate( offset[, offset]? ) |
Translates an element on the 2D plane. | |
translatex( offset ) |
Translates an element horizontally. | |
translatey( offset ) |
Translates an element vertically. | |
translate3d( offset, offset, offset ) |
Translates an element in 3D space. | |
scale( number[, number]? ) |
Scales an element up or down on the 2D plane. | |
scalex( number ) |
Scales an element up or down horizontally. | |
scaley( number ) |
Scales an element up or down vertically. | |
skew( angle[, angle]? ) |
Skews an element on the 2D plane. | |
skewx( angle ) |
Skews an element in the horizontal direction. | |
skewy( angle ) |
Skews an element in the vertical direction. | |
supports([ <supports-condition> | <declaration> ]) |
Interpreted as a @supports
condition. |
@import |
In this section you find the documentation for the supported CSS at-rules.
The following at-rules have to appear at the beginning of the CSS document, and exactly in this order:
@charset |
Defines the fallback encoding to use for the stylesheet. Prince supports stylesheets
in UTF-8, UTF-16, Latin1 and Windows-1252. |
@import [ <url(URL)> | <string> ] supports(...)?
<media-query-list>? |
Allows authors to import style rules from other style sheets. The url(URL)
or <string> give the URL of the style sheet to be imported, while
the optional supports(...) expression and <media-query-list>
state the import conditions. |
@namespace [Prefix]? [ <url(URL)> | <string> ] |
Defines a namespace prefix or default namespace to be used in the stylesheet. |
After the initial at-rules, the following at-rules can appear also in nested form in the CSS document:
@page [Name] Selectors { Page-declarations } |
|
|---|---|
| Modifies margins, orphans, widows and page breaks of a document when printing it. The pages are identified either by a name, or by a page pseudo-class and page declarations can either be style declarations or page region at-rules. | |
:left |
Page pseudo-classes |
:right |
|
:recto |
|
:verso |
|
:first |
|
:blank |
|
:nth(N) |
|
@left-top | @left-middle | @left |
@left-bottom
|
Page region at-rules |
@right-top | @right-middle | @right |
@right-bottom
|
|
@top-left-corner | @top-left | @top-center |
@top-right | @top-right-corner
|
|
@bottom-left-corner | @bottom-left | @bottom-center |
@bottom-right | @bottom-right-corner
|
|
@page-float-top | @page-float-bottom
|
|
@footnote | @footnotes
|
|
The @page rule takes the following CSS properties:
prince-bleed |
prince-mark-length |
prince-mark-offset |
prince-mark-width |
prince-pdf-page-colorspace |
prince-pdf-page-label |
prince-rotate-body |
prince-shrink-to-fit |
prince-trim |
size
|
|
@media Media-query-list { Rules } |
|---|
| The rules will apply if the device meets the criteria of the condition defined in the media query. See CSS Media Queries for details. |
@supports Condition { Rules } |
|---|
Checks whether particular property:value combinations are supported.
Unlike media queries, this uses the classical two-valued logic. |
@font-face { Font-declarations } |
|
|---|---|
| Links a font family to an actual font. | |
The @font-face rule takes the following CSS descriptors: |
|
font-family: <family-name> |
This descriptor defines the font family name that will be used in all CSS font
family name matching. It is required for the @font-face rule to be valid. |
src: [ url(<URL>) format(<string>#)? | local(<family-name>) |
prince-lookup(<family-name>) ]# |
This descriptor specifies the resource containing font data. It is required for
the @font-face rule to be valid. The local() function searches
for locally installed system fonts, but prince-lookup() will also find
fonts defined by other @font-face rules. |
unicode-range: <urange># |
This descriptor defines the set of Unicode codepoints that may be supported by the font face. The descriptor value is a comma-delimited list of Unicode range values. |
Additionally, @font-face takes the CSS descriptors
font-variant, font-stretch,
font-weight and font-style,
which take the same values as the CSS properties with the same name. |
|
@prince-color Name { alternate-color: ... } |
|
|---|---|
| Defines a new color name. | |
The @prince-color rule takes the mandatory
alternate-color property to specify an alternate
color to use if the named spot color is not available. The named color is used in
a stylesheet with the prince-color() function. |
@prince-pdf Name { Declarations } |
|
|---|---|
| Defines properties relating to PDFs. | |
The @prince-pdf rule takes the following CSS properties:
prince-fallback-cmyk-profile |
prince-filter-resolution |
prince-pdf-color-conversion |
prince-pdf-color-options |
prince-pdf-open-action |
prince-pdf-output-intent |
prince-pdf-page-layout |
prince-pdf-page-mode |
prince-pdf-paper-tray |
prince-pdf-print-scaling |
prince-pdf-profile |
prince-pdf-script |
prince-pdf-xmp
|
Prince supports most of ECMAScript 5th edition, but not strict mode. Later editions of ECMAScript are not supported.
The following table shows supported JavaScript objects, methods and properties. For more details, see also JavaScript in Prince.
* objects, methods and properties marked with an asterisk are Prince extensions.
Prince supports the following page size keywords.
Keywords are not case sensitive, thus "A4" and "a4" are equivalent.
| Keyword | Page Size |
|---|---|
| A0 | 841mm × 1189mm |
| A1 | 594mm × 841mm |
| A2 | 420mm × 594mm |
| A3 | 297mm × 420mm |
| A4 | 210mm × 297mm |
| A5 | 148mm × 210mm |
| A6 | 105mm × 148mm |
| A7 | 74mm × 105mm |
| A8 | 52mm × 74mm |
| A9 | 37mm × 52mm |
| A10 | 26mm × 37mm |
| B0 | 1000mm × 1414mm |
| B1 | 707mm × 1000mm |
| B2 | 500mm × 707mm |
| B3 | 353mm × 500mm |
| B4 | 250mm × 353mm |
| B5 | 176mm × 250mm |
| B6 | 125mm × 176mm |
| B7 | 88mm × 125mm |
| B8 | 62mm × 88mm |
| B9 | 44mm × 62mm |
| B10 | 31mm × 44mm |
| C0 | 917mm × 1297mm |
| C1 | 648mm × 917mm |
| C2 | 458mm × 648mm |
| C3 | 324mm × 458mm |
| C4 | 229mm × 324mm |
| C5 | 162mm × 229mm |
| C6 | 114mm × 162mm |
| C7 | 81mm × 114mm |
| C8 | 57mm × 81mm |
| C9 | 40mm × 57mm |
| C10 | 28mm × 40mm |
| id-1 | 85.60mm × 53.98mm |
| id-2 | 105.0mm × 74.0mm |
| id-3 | 125.0mm × 88.0mm |
| US-Letter | 8.5in × 11.0in |
| US-Legal | 8.5in × 14.0in |
| US-Executive | 7.25in × 10.5in |
| US-Ledger | 17.0in × 11.0in |
| US-Tabloid | 11.0in × 17.0in |
| US-Government | 8.0in × 11.0in |
| US-Statement | 5.5in × 8.5in |
| US-Folio | 8.5in × 13.0in |
| ansi-a | 8.5in × 11.0in |
| ansi-b | 11.0in × 17.0in |
| ansi-c | 17.0in × 22.0in |
| ansi-d | 22.0in × 34.0in |
| ansi-e | 34.0in × 44.0in |
| arch-a | 9.0in × 12.0in |
| arch-b | 12.0in × 18.0in |
| arch-c | 18.0in × 24.0in |
| arch-d | 24.0in × 36.0in |
| arch-e1 | 30.0in × 42.0in |
| arch-e | 36.0in × 48.0in |
| imperial-folio | 15.0in × 22.0in |
| imperial-quarto | 11.0in × 15.0in |
| imperial-octavo | 7.5in × 11.0in |
| royal-folio | 12.5in × 20.0in |
| royal-quarto | 10.0in × 12.5in |
| royal-octavo | 6.25in × 10.0in |
| crown-folio | 10.0in × 15.0in |
| crown-quarto | 7.5in × 10.0in |
| crown-octavo | 5.0in × 7.5in |
| foolscap-folio | 8.5in × 13.5in |
| foolscap-quarto | 6.75in × 8.5in |
| foolscap-octavo | 4.25in × 6.75in |
| medium-quarto | 9.0in × 11.5in |
| demy-quarto | 8.75in × 11.25in |
| demy-octavo | 5.625in × 8.75in |
Character entities are a method of including arbitrary characters in XML documents by referencing their UNICODE number rather than writing them directly. CSS has a similar mechanism to include special characters.
This can be convenient when you wish to include characters such as smart quotes, symbols or mathematical operators that do not exist in the character encoding that you are using for your XML documents (such as ASCII or ISO-8859-1 "Latin-1"), or when you want to insert some of these characters into the final layout by means of CSS.
Here is an example of including smart quotes in an XML document using character entities:
XML
<p>
These are “smart quotes” to be precise.
</p>
Output
A typical usecase for character entities in CSS is the
prince-text-replace property, which
replaces a certain character string with another one. In the sample
"Reconstructed Essay"
(HTML -
PDF),
the property is used to replace occurrences of "s" with the "long s" to recreate
the original printed book.
CSS
body {
prince-text-replace: "s" "\017F";
}The tables below are a quick reference for some commonly requested UNICODE characters, expressed in XML and CSS notation; for everything else please consult the UNICODE code charts.
| XML | CSS | Character | Name |
|---|---|---|---|
| À | \C0 | À | A grave |
| Á | \C1 | Á | A acute |
| Â | \C2 | Â | A circumflex |
| Ã | \C3 | Ã | A tilde |
| Ä | \C4 | Ä | A dieresis |
| Å | \C5 | Å | A ring |
| Ç | \C7 | Ç | C cedilla |
| È | \C8 | È | E grave |
| É | \C9 | É | E acute |
| Ê | \CA | Ê | E circumflex |
| Ë | \CB | Ë | E dieresis |
| Ì | \CC | Ì | I grave |
| Í | \CD | Í | I acute |
| Î | \CE | Î | I circumflex |
| Ï | \CF | Ï | I dieresis |
| Ñ | \D1 | Ñ | N tilde |
| Ò | \D2 | Ò | O grave |
| Ó | \D3 | Ó | O acute |
| Ô | \D4 | Ô | O circumflex |
| Õ | \D5 | Õ | O tilde |
| Ö | \D6 | Ö | O dieresis |
| Ø | \D8 | Ø | O slash |
| Ù | \D9 | Ù | U grave |
| Ú | \DA | Ú | U acute |
| Û | \DB | Û | U circumflex |
| Ü | \DC | Ü | U dieresis |
| Ÿ | \0178 | Ÿ | Y dieresis |
| à | \E0 | à | a grave |
| á | \E1 | á | a acute |
| â | \E2 | â | a circumflex |
| ã | \E3 | ã | a tilde |
| ä | \E4 | ä | a dieresis |
| å | \E5 | å | a ring |
| ç | \E7 | ç | c cedilla |
| è | \E8 | è | e grave |
| é | \E9 | é | e acute |
| ê | \EA | ê | e circumflex |
| ë | \EB | ë | e dieresis |
| ì | \EC | ì | i grave |
| í | \ED | í | i acute |
| î | \EE | î | i circumflex |
| ï | \EF | ï | i dieresis |
| ı | \0131 | ı | dotless i |
| ñ | \F1 | ñ | n tilde |
| ò | \F2 | ò | o grave |
| ó | \F3 | ó | o acute |
| ô | \F4 | ô | o circumflex |
| õ | \F5 | õ | o tilde |
| ö | \F6 | ö | o dieresis |
| ø | \F8 | ø | o slash |
| ù | \F9 | ù | u grave |
| ú | \FA | ú | u acute |
| û | \FB | û | u circumflex |
| ü | \FC | ü | u dieresis |
| ÿ | \FF | ÿ | y dieresis |
| XML | CSS | Character | Name |
|---|---|---|---|
| • | \2022 | • | bullet |
| ¢ | \A2 | ¢ | cent |
| © | \A9 | © | copyright |
| ¤ | \A4 | ¤ | currency |
| † | \2020 | † | dagger |
| ° | \B0 | ° | degree |
| ÷ | \F7 | ÷ | divide |
| ‡ | \2021 | ‡ | double dagger |
| ƒ | \0192 | ƒ | florin |
| ⁄ | \2044 | ⁄ | fraction |
| ¡ | \A1 | ¡ | inverted exclamation |
| ¿ | \BF | ¿ | inverted question |
| µ | \B5 | µ | micro |
| · | \B7 | · | middle dot |
| ¬ | \AC | ¬ | not |
| ª | \AA | ª | ordfeminine |
| º | \BA | º | ordmasculine |
| ¶ | \B6 | ¶ | paragraph |
| ‰ | \2030 | ‰ | perthousand |
| ± | \B1 | ± | plusminus |
| ® | \AE | ® | registered |
| § | \A7 | § | section |
| £ | \A3 | £ | sterling |
| ™ | \2122 | ™ | trademark |
| ¥ | \A5 | ¥ | yen |
| XML | CSS | Character | Name |
|---|---|---|---|
| ‘ | \2018 | ‘ | left single quote |
| ’ | \2019 | ’ | right single quote |
| “ | \201C | “ | left double quote |
| ” | \201D | ” | right double quote |
| ‹ | \2039 | ‹ | left single guillemet |
| › | \203A | › | right single guillemet |
| « | \AB | « | left double guillemet |
| » | \BB | » | right double guillemet |
| ‚ | \201A | ‚ | base single quote |
| „ | \201E | „ | base double quote |
| XML | CSS | Character | Name |
|---|---|---|---|
| ´ | \xB4 | ´ | acute |
| ˘ | \x02D8 | ˘ | breve |
| ˇ | \x02C7 | ˇ | caron |
| ¸ | \xB8 | ¸ | cedilla |
| ^ | \x5E | ^ | circumflex |
| ¨ | \xA8 | ¨ | dieresis |
| ˙ | \x02D9 | ˙ | dot accent |
| ˝ | \x02DD | ˝ | double acute |
| ¯ | \xAF | ¯ | macron |
| ˛ | \x02DB | ˛ | ogonek |
| ˚ | \x02DA | ˚ | ring |
| ˜ | \x02DC | ˜ | tilde |
| XML | CSS | Character | Name |
|---|---|---|---|
|   | \x20 | foo bar | space |
|   | \xa0 | foo bar | no-break space |
|   | \x2008 | foo bar | punctuation space |
|   | \x2009 | foo bar | thin space |
|   | \x200a | foo bar | hair space |
| ​ | \x200b | foobar | zero width space |
|   | \x202f | foo bar | narrow no-break space |
|   | \x205f | foo bar | medium mathematical space |
|  | \xfeff | foobar | zero width no-break space |
|   | \x1680 | foo bar | ogham space mark |
|   | \x2000 | foo bar | en quad |
|   | \x2001 | foo bar | em quad |
|   | \x2002 | foo bar | en space |
|   | \x2003 | foo bar | em space |
| 　 | \x3000 | foo bar | ideographic space |
| XML | CSS | Character | Name |
|---|---|---|---|
| … | \x2026 | … | ellipsis |
| — | \x2014 | — | em dash |
| – | \x2013 | – | en dash |
| fi | \xFB01 | fi | fi ligature |
| fl | \xFB02 | fl | fl ligature |
| Æ | \xC6 | Æ | AE |
| æ | \xE6 | æ | ae |
| Π| \x0152 | Π| OE |
| œ | \x0153 | œ | oe |
| ß | \xDF | ß | sharp s |
Prince uses the following open source projects: