Blame view

export/PHPRtfLite-1.3.1/docs/html/_sources/document-settings.txt 2.52 KB
f90e19c3   Andrea Petta   plugin update
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  Document settings
  *****************
  
  Page orientation
  ----------------
  
  You can use between ``landscape`` and ``portrait`` (default) page orientation.
  
  .. code-block:: php
      
      <?php
      // rtf document instance
      $rtf = new PHPRtfLite();
      // landscape page orientation
      $rtf->setLandscape();
  
  
  .. _doc-settings_page-margins:
     
  Page margins
  ------------
  
  You can set margins for the document and for sections, too. Section margins will overwrite document margins.
  
  .. code-block:: php
      
      <?php
      $rtf = new PHPRtfLite();
      // margin left: 1cm
      $rtf->setMarginLeft(1);
      // margin right: 2cm
      $rtf->setMarginRight(2);
      // margin top: 3cm
      $rtf->setMarginTop(3);
      // margin bottom: 4cm
      $rtf->setMarginBottom(4);
      
  
  The code example below does the same in a shorter way.
      
  .. code-block:: php
  
      <?php
      $rtf = new PHPRtfLite();
      // margins: left 1cm, top 3cm, right 2cm, bottom 4cm
      $rtf->setMargins(1, 3, 2, 4);
  
      
  You can define that odd and even pages uses mirrored margins. Section margins can be mirrored, too, and will overwrite the document setting.
  
  .. code-block:: php
  
      <?php
      $rtf = new PHPRtfLite();
      // margin left: 2cm
      $rtf->setMarginLeft(2);
      // margin right: 1cm
      $rtf->setMarginRight(1);
      // odd pages: left 2cm, right 1cm
      // even pages: left 1cm, right 2cm
      $rtf->setMirrorMarings();
      
  .. _doc-settings_page-size:
      
  Page size
  ---------
  
  The paper width and height can be set for sections, too, which will overwrite the document settings.
  
  .. code-block:: php
  
      <?php
      $rtf = new PHPRtfLite();
      $rtf->setPaperWidth(14);  // in cm
      $rtf->setPaperHeight(25); // in cm
  
      
  Units in RTF
  ==========================
  
  RTF uses TWIP ("TWentieth of an Inch Point" - 1/20 Point = 1/1440 Inch) [#f1]_ as internal unit. PHPRtfLite uses centimeter as default unit for all measuring unit inputs.
  
  .. code-block:: php
  
      <?php
      PHPRtfLite_Unit::setGlobalUnit(PHPRtfLite_Unit::UNIT_CM);    // inputs used as centimeters
      PHPRtfLite_Unit::setGlobalUnit(PHPRtfLite_Unit::UNIT_INCH);  // inputs used as inches
      PHPRtfLite_Unit::setGlobalUnit(PHPRtfLite_Unit::UNIT_POINT); // inputs used as points
  
  
  .. [#f1] `<http://en.wikipedia.org/wiki/Twip>`_
  
      
  Character set (text input)
  ==========================
  
  .. code-block:: php
  
      <?php
      $rtf = new PHPRtfLite();
      $rtf->setCharset('Latin1');  // use Latin1 instead of UTF-8
      
      
  Hyphenation
  =====================
  
  .. code-block:: php
  
      <?php
      $rtf = new PHPRtfLite();
      $rtf->setHyphenation();