Skip to content

Commit

Permalink
replace spans around Default or spans around true/false by code-tags
Browse files Browse the repository at this point in the history
  • Loading branch information
Klap-in authored and finwe committed Sep 29, 2017
1 parent 17740f8 commit 1366e12
Show file tree
Hide file tree
Showing 45 changed files with 99 additions and 101 deletions.
2 changes: 1 addition & 1 deletion fonts-languages/lang-v5-x.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ recognised in `<body>` or `<html>` tags.

**Important:** Support for the attribute <span class="parameter">$lang</span> is only active when the variable
<a href="{{ "/reference/mpdf-variables/uselang.html" | prepend: site.baseurl }}">$useLang</a> is set to
<span class="smallblock">TRUE</span> (<span class="smallblock">DEFAULT</span>).
`true` (Default).

The language codes supported are determined by <span class="filename">config_cp.php</span> :

Expand Down
3 changes: 2 additions & 1 deletion headers-footers/headers-top-margins.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ If you specify a header that extends further down the page than the margin-top,
# Alternative margin usage

The configuration variables <a href="{{ "/reference/mpdf-variables/setautotopmargin.html" | prepend: site.baseurl }}">`$setAutoTopMargin`</a>
and <a href="{{ "/reference/mpdf-variables/setautotopmargin.html" | prepend: site.baseurl }}">`$setAutoBottomMargin`</a> can be set. Both default to <span class="smallblock">FALSE</span>.
and <a href="{{ "/reference/mpdf-variables/setautotopmargin.html" | prepend: site.baseurl }}">`$setAutoBottomMargin`</a>
can be set. Both default to `false`.

## pad

Expand Down
2 changes: 1 addition & 1 deletion reference/html-control-tags/annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Annotations cannot be moved or deleted by the reader.

: Sets the appearance of the Annotation marker.

<span class="smallblock">BLANK</span> or omitted uses <span class="smallblock">DEFAULT</span> i.e. `'Note'`
<span class="smallblock">BLANK</span> or omitted uses Default: i.e. `'Note'`

**Values** (case sensitive)

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/addpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ Number of pages added:
* a pre-defined page size (see below),
* or as an array of width and height in millimetres e.g. `array(210,297)`.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">BLANK</span> - makes no change to the current sheet-size
Default: <span class="smallblock">BLANK</span> - makes no change to the current sheet-size

**Values** (case-insensitive)
* `'A0'` - `'A10'`, `'B0'` - `'B10'`, `'C0'` - `'C10'`
Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/addpagebyarray.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Number of pages added:
* a pre-defined page size,
* or as an array of width and height in millimetres e.g. `array(210, 297)`.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">BLANK</span> - makes no change to the current sheet-size
Default: <span class="smallblock">BLANK</span> - makes no change to the current sheet-size

**Values** (case-insensitive)

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/addspotcolor.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Define a Spot colour which can be used in the document. Spot colours need to be

: Specifies the CMYK values to be used to display in the document or if the spot colour is not available.

<span class="smallblock">DEFAULT</span>: `0`
Default: `0`

# Examples

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/aliasnbpagegroups.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ number of pages in the whole document.

: Defines the text for the variable <span class="parameter">$aliasNbPgGp</span>.

<span class="smallblock">DEFAULT</span>: `'{nbpg}'`
Default: `'{nbpg}'`

# Examples

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/aliasnbpages.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ which is used as a placeholder used to insert total number of pages into the doc

: Defines the text for the variable <span class="parameter">$aliasNbPg</span>.

<span class="smallblock">DEFAULT</span>: `'{nb}'`
Default: `'{nb}'`

# Examples

Expand Down
12 changes: 6 additions & 6 deletions reference/mpdf-functions/annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Annotations cannot be moved or deleted by the reader

: Sets the appearance of the Annotation marker.

<span class="smallblock">BLANK</span> or omitted uses <span class="smallblock">DEFAULT</span> i.e. `'Note'`
<span class="smallblock">BLANK</span> or omitted uses default value i.e. `'Note'`

**Values** (case sensitive)

Expand All @@ -92,29 +92,29 @@ Annotations cannot be moved or deleted by the reader

: This specifies the name of the Author which will appear at the top of the popup text box.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">BLANK</span>
Default: <span class="smallblock">BLANK</span>

<span class="parameter">$subject</span>

: This specifies the text to appear in the Annotation properties.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">BLANK</span>
Default: <span class="smallblock">BLANK</span>

<span class="parameter">$opacity</span>

: Sets the opacity of the Annotation marker. Values must be greater than `0` and <= `1`.

<span class="smallblock">BLANK</span> or omitted or `0`: sets the opacity to the value of
<a href="{{ "/reference/mpdf-variables/annotopacity.html" | prepend: site.baseurl }}">annotOpacity</a>
(<span class="smallblock">DEFAULT</span> `0.5`),
(Default: `0.5`),
unless <a href="{{ "/reference/mpdf-variables/annotmargin.html" | prepend: site.baseurl }}">annotMargin</a>
forces the Annotations to appear in the margin, when the <span class="smallblock">DEFAULT</span> is `1`
forces the Annotations to appear in the margin, when the default value is `1`

<span class="parameter">$colarray</span>

: An array containing RGB color specification, which determines the colour of the Annotation marker background

<span class="smallblock">DEFAULT</span> `array(255,255,0)` i.e. Yellow
Default: `array(255,255,0)` i.e. Yellow

<span class="parameter">$popup</span>

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/bookmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The target is set as the current writing position in the document when the Bookm
: <span class="parameter">$level</span> specifies the "tree" level for the Bookmark. The top level is 0. See Example 2
below. Accepts an integer from `0` to the maximum depth you wish.

<span class="smallblock">DEFAULT</span>: `0`
Default: `0`

<span class="parameter">$y</span>

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/construct.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Initialise an instance of mPDF class.

* Apart from configuration variables defined in
`ConfigVariables` and `FontVariables` classes it can obtain variables which where the arguments
from the constructor of mPDF < 7.0: `mode`, `format`, `default_font_size`, `default_font`, `margin_left`,
from the constructor of mPDF&nbsp;<&nbsp;7.0: `mode`, `format`, `default_font_size`, `default_font`, `margin_left`,
`margin_right`, `margin_top`, `margin_bottom`, `margin_header`, `margin_footer`, `orientation`. These variables are described with
their defaults in the next section.

Expand Down
10 changes: 5 additions & 5 deletions reference/mpdf-functions/createindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ or <a href="{{ "/reference/mpdf-functions/indexentry.html" | prepend: site.baseu

<span class="smallblock">BLANK</span> or omitted or `0` or `1` uses the whole page is used as one column.

<span class="smallblock">DEFAULT</span>: `1`
Default: `1`

<span class="parameter">$fontsize</span>

Expand All @@ -64,7 +64,7 @@ or <a href="{{ "/reference/mpdf-functions/indexentry.html" | prepend: site.baseu

<span class="smallblock">BLANK</span> or omitted or `0` uses the default value.

<span class="smallblock">DEFAULT</span>: `1.2`  (changed from `1.0` in mPDF < 3.0)
Default: `1.2`  (changed from `1.0` in mPDF < 3.0)

<span class="parameter">$offset</span>

Expand All @@ -76,7 +76,7 @@ or <a href="{{ "/reference/mpdf-functions/indexentry.html" | prepend: site.baseu

: Defines whether to divide index entries starting with the same letter, using a (large) letter as a heading.

<span class="smallblock">DEFAULT</span>: `1`
Default: `1`

**Values**

Expand All @@ -97,7 +97,7 @@ or <a href="{{ "/reference/mpdf-functions/indexentry.html" | prepend: site.baseu

<span class="smallblock">BLANK</span> or omitted uses the default value.

<span class="smallblock">DEFAULT</span>: `5` (mm)
Default: `5` (mm)

<span class="parameter">$font </span>

Expand All @@ -117,7 +117,7 @@ or <a href="{{ "/reference/mpdf-functions/indexentry.html" | prepend: site.baseu

* `true` or `1`: add links to Index
* <span class="smallblock">BLANK</span> or omitted, `0` or `false`: do not add links to the Index
* <span class="smallblock">DEFAULT</span>: `false`
* Default: `false`


# Changelog
Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/deffooterbyname.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ e.g. <a href="{{ "/reference/mpdf-functions/setheaderbyname.html" | prepend: sit
: This parameter specifies the content of the page footer as an array.


<span class="smallblock">DEFAULT</span>: `array()`
Default: `array()`

**Values** in the array:
* <span class="parameter">L</span>: subarray for left
Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/defheaderbyname.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Define a page header with a given name. Named headers can be referenced and set

: This parameter specifies the content of the page header as an array.

<span class="smallblock">DEFAULT</span>: array()
Default: array()

**Values** in the array
* <span class="parameter">L</span>: subarray for left
Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/defhtmlfooterbyname.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Define an HTML page footer with a given name. Named footers can be referenced an

: This parameter specifies the content of the page footer as a string of valid HTML code.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">BLANK</span>
Default: <span class="smallblock">BLANK</span>

# Changelog

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/defhtmlheaderbyname.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Define an HTML page header with a given name. Named headers can be referenced an

: This parameter specifies the content of the page header as a string of valid HTML code.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">BLANK</span>
Default: <span class="smallblock">BLANK</span>

# Changelog

Expand Down
10 changes: 5 additions & 5 deletions reference/mpdf-functions/importpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,33 +31,33 @@ is created in mPDF which stores the image of this page, ready to insert into the
: This parameter specifies the page number from the source PDF file to import.  <span class="parameter">$pageno</span> should
be a positive integer value.

<span class="smallblock">DEFAULT</span>: `1`
Default: `1`

<span class="parameter">$crop_x</span>

: Specifies the x-coordinate (abscissa) for the page of the source PDF file, when importing a 'cropped' page into the template.
Value in millimetres.

<span class="smallblock">DEFAULT</span>: `0`
Default: `0`

<span class="parameter">$crop_y</span>

: Specifies the y-coordinate (ordinate) for the page of the source PDF file, when importing a 'cropped' page into the template.
Value in millimetres.

<span class="smallblock">DEFAULT</span>: `0`
Default: `0`

<span class="parameter">$crop_w</span>

: Specifies the width in millimetres when importing a 'cropped' page into the template.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">NULL</span> uses the full page width from the source file
Default: <span class="smallblock">NULL</span> uses the full page width from the source file

<span class="parameter">$crop_h</span>

: Specifies the height in millimetres when importing a 'cropped' page into the template.

<span class="smallblock">DEFAULT</span>: <span class="smallblock">NULL</span> uses the full page height from the source file
Default: <span class="smallblock">NULL</span> uses the full page height from the source file

<span class="parameter">$boxname</span>

Expand Down
4 changes: 2 additions & 2 deletions reference/mpdf-functions/insertindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ or <a href="{{ "/reference/mpdf-functions/indexentry.html" | prepend: site.baseu

: Defines whether to divide index entries starting with the same letter, using a (large) letter as a heading.

<span class="smallblock">DEFAULT</span>: `1`
Default: `1`

**Values**
* `1` : show dividing letters in the Index
Expand All @@ -41,7 +41,7 @@ or <a href="{{ "/reference/mpdf-functions/indexentry.html" | prepend: site.baseu

: Specify whether to add hyperlinks (internal links) to the entries in the document Index.

<span class="smallblock">DEFAULT</span>: `false`
Default: `false`

**Values**
* `true` or `1`: add links to Index
Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Send the document to a given destination: browser, file or string. In the case o
: Destination where to send the document. Use class constants from `\Mpdf\Output\Destination` for better readability
and understandability

<span class="smallblock">DEFAULT</span>: `\Mpdf\Output\Destination::INLINE`
Default: `\Mpdf\Output\Destination::INLINE`

**Values**:
`\Mpdf\Output\Destination::INLINE`
Expand Down
4 changes: 2 additions & 2 deletions reference/mpdf-functions/overwrite.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ is longer than the <span class="parameter">$search</span> string, it may overlap

: <span class="parameter">$dest</span> specifies the destination for the generated PDF document.

<span class="smallblock">DEFAULT</span>: `"D"`
Default: `"D"`

**Values**

Expand All @@ -90,7 +90,7 @@ is longer than the <span class="parameter">$search</span> string, it may overlap
: This parameter specifies the filename for the output PDF file. No path should be included unless
<span class="parameter">$dest</span> is set as `"F"`.

<span class="smallblock">DEFAULT</span>: `"mpdf.pdf"`
Default: `"mpdf.pdf"`

# Return Value

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/setalpha.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Set the opacity and blend mode for Images
* `'Color'`
* `'Luminosity'`

<span class="smallblock">DEFAULT</span>: `'Normal'`
Default: `'Normal'`

# Changelog

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/setanchor2bookmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ simply sets the variable <a href="{{ "/reference/mpdf-variables/anchor2bookmark.
* `0` - does not generate a bookmark
* `1` - generate a bookmark using the text value of the <span class="parameter">$name</span> attribute

<span class="smallblock">DEFAULT</span>: `0`
Default: `0`

# Changelog

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/setautofont.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ but note that `SetAutoFont()` also:
* `AUTOFONT_INDIC` = 8 - Indic languages such as Devanagari
* `AUTOFONT_ALL` = 15 - All of the above

<span class="smallblock">DEFAULT</span>: `AUTOFONT_ALL` (15)
Default: `AUTOFONT_ALL` (15)

# Changelog

Expand Down
6 changes: 3 additions & 3 deletions reference/mpdf-functions/setcolumns.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Define, start or stop Columns in the document.

<span class="smallblock">BLANK</span> or omitted or `0` or `1` turns Columns OFF i.e. the whole page is used as one column.

<span class="smallblock">DEFAULT</span>: `1`
Default: `1`

<span class="parameter">$vAlign</span>

Expand All @@ -53,15 +53,15 @@ Define, start or stop Columns in the document.
* `''` (<span class="smallblock">BLANK</span>) or omitted: turns vertical alignment off
* `'J'` or `'justify'`: Automatically adjusts height of columns to be equal

<span class="smallblock">DEFAULT</span>: `''`
Default: `''`

<span class="parameter">$gap</span>

: Set the gap between columns in millimeters

<span class="smallblock">BLANK</span> or omitted uses default value.

<span class="smallblock">DEFAULT</span>: `5` (mm)
Default: `5` (mm)

# Examples

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/setcompression.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ default to `true` on initialising the mPDF class.

: `true` or `false` to specify whether mPDF should compress the data for the PDF file.

<span class="smallblock">DEFAULT</span>: `true`
Default: `true`

# Examples

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/setdirectionality.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ for more details. If `SetDirectionality('rtl')` is set, *Text Bidirectionality*
* `'ltr'`
* `'rtl'`

<span class="smallblock">DEFAULT</span>: `'ltr'`
Default: `'ltr'`

# Examples

Expand Down
2 changes: 1 addition & 1 deletion reference/mpdf-functions/setdisplaymode.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Adobe Reader, these values will determine the initial appearance and layout.
* `'default'`
: User's default setting in Adobe Reader

<span class="smallblock">DEFAULT</span>: `'continuous'`
Default: `'continuous'`


# Examples
Expand Down
4 changes: 2 additions & 2 deletions reference/mpdf-functions/setdisplaypreferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ When the user opens the finished file in Adobe Reader, these values will determi
: This parameter takes a string containing any one or more of the possible values separated by any characters
(e.g. comma, forward slash or space).

All the options start as <span class="smallblock">FALSE</span>, and can only be set <span class="smallblock">TRUE</span>
by this command. Each setting is added to those previously set.
All the options start as `false`, and can only be set `true` by this command. Each setting is added to those
previously set.

**Values** (case-sensitive)

Expand Down
Loading

0 comments on commit 1366e12

Please sign in to comment.