Skip to content

Commit deb7d81

Browse files
afilinaGirgias
authored andcommitted
Remove references to PDF from docs and code comments
1 parent a798ac5 commit deb7d81

7 files changed

Lines changed: 13 additions & 22 deletions

File tree

README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ you can write a custom syntax highlighter.
166166
A syntax highlighter for PhD is nothing more than a simple PHP class
167167
that has two methods: `factory` and `highlight`.
168168

169-
`factory` is static, takes the format name (i.e. `pdf`, `xhtml`,
169+
`factory` is static, takes the format name (i.e. `xhtml`,
170170
`troff`) as its only parameter and returns the highlighter instance object
171171
for the given format. The method is called for each output format the
172172
documentation is rendered to.
@@ -234,13 +234,6 @@ PhD currently supports the following output formats:
234234
<tr>
235235
<td rowspan="6"></td>
236236
<td>howto</td>
237-
</tr>
238-
<tr>
239-
<td>pdf</td>
240-
</tr>
241-
<tr>
242-
<td>bigpdf</td>
243-
</tr>
244237
<tr>
245238
<td>kdevelop</td>
246239
</tr>

docs/phd-guide/phd-guide.xml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<para>PhD is PHP's very own DocBook 5 rendering system. It is used to
1616
convert the <acronym>PHP</acronym> Manual and PEAR Documentation into
17-
different output formats like XHTML, PDF, Man pages and CHM.</para>
17+
different output formats like XHTML, Man pages and CHM.</para>
1818

1919
<para>The goal of PhD is to become a fast, general DocBook rendering
2020
system. At the moment of writing, PhD is already very fast: It can create
@@ -261,8 +261,6 @@ Supported packages:
261261
php
262262
howto
263263
manpage
264-
pdf
265-
bigpdf
266264
kdevelop
267265
chm
268266
tocfeed
@@ -280,7 +278,7 @@ Supported packages:
280278

281279

282280
<para>You can tell by the output of the <literal>--list</literal> option
283-
that PhD can also be used to render the docs as a PDF file, or as Unix
281+
that PhD can also be used to render the docs as Unix
284282
Man Pages.</para>
285283

286284
<para>To select a format and package, you must use the <literal>-f
@@ -645,7 +643,7 @@ $ pear install mediawiki/geshi]]></screen>
645643
and <literal>highlight</literal>.</para>
646644

647645
<para><literal>factory</literal> is static and takes the format name
648-
(i.e. <literal>pdf</literal>, <literal>xhtml</literal>,
646+
(i.e. <literal>xhtml</literal>,
649647
<literal>troff</literal>) as only parameter. It returns
650648
the highlighter instance object for the given format.
651649
The method is called for each output format the documentation

phpdotnet/phd/Format.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ public function rowspan($attrs) {
512512
*
513513
* @param string $text Text to highlight
514514
* @param string $role Source code role to use (php, xml, html, ...)
515-
* @param string $format Format to highlight (pdf, xhtml, troff, ...)
515+
* @param string $format Format to highlight (xhtml, troff, ...)
516516
*
517517
* @return string Highlighted code
518518
*/

phpdotnet/phd/Highlighter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class Highlighter
2929
* We use a factory so you can return different objects/classes
3030
* per format.
3131
*
32-
* @param string $format Output format (pdf, xhtml, troff, ...)
32+
* @param string $format Output format (xhtml, troff, ...)
3333
*
3434
* @return Highlighter Highlighter object
3535
*/
@@ -47,7 +47,7 @@ public static function factory($format)
4747
*
4848
* @param string $text Text to highlight
4949
* @param string $role Source code role to use (php, xml, html, ...)
50-
* @param string $format Output format (pdf, xhtml, troff, ...)
50+
* @param string $format Output format (xhtml, troff, ...)
5151
*
5252
* @return string Highlighted code
5353
*/

phpdotnet/phd/Highlighter/GeSHi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class Highlighter_GeSHi extends Highlighter
4949
* We use a factory so you can return different objects/classes
5050
* per format.
5151
*
52-
* @param string $format Output format (pdf, xhtml, troff, ...)
52+
* @param string $format Output format (xhtml, troff, ...)
5353
*
5454
* @return Highlighter Highlighter object
5555
*/
@@ -71,7 +71,7 @@ public static function factory($format)
7171
*
7272
* @param string $text Text to highlight
7373
* @param string $role Source code role to use (php, xml, html, ...)
74-
* @param string $format Output format (pdf, xhtml, troff, ...)
74+
* @param string $format Output format (xhtml, troff, ...)
7575
*
7676
* @return string Highlighted code
7777
*/

phpdotnet/phd/Highlighter/GeSHi11x.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class Highlighter_GeSHi11x extends Highlighter
4343
* We use a factory so you can return different objects/classes
4444
* per format.
4545
*
46-
* @param string $format Output format (pdf, xhtml, troff, ...)
46+
* @param string $format Output format (xhtml, troff, ...)
4747
*
4848
* @return Highlighter Highlighter object
4949
*/
@@ -89,7 +89,7 @@ public function __construct(\GeSHiRenderer $renderer)
8989
*
9090
* @param string $text Text to highlight
9191
* @param string $role Source code role to use (php, xml, html, ...)
92-
* @param string $format Output format (pdf, xhtml, troff, ...)
92+
* @param string $format Output format (xhtml, troff, ...)
9393
*
9494
* @return string Highlighted code
9595
*/

phpdotnet/phd/Options/Handler.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ public function __construct(
1515
public function optionList(): array
1616
{
1717
return [
18-
'format:' => 'f:', // The format to render (xhtml, pdf...)
18+
'format:' => 'f:', // The format to render (xhtml, troff...)
1919
'noindex' => 'I', // Do not re-index
2020
'forceindex' => 'r', // Force re-indexing under all circumstances
2121
'notoc' => 't', // Do not re-create TOC
2222
'docbook:' => 'd:', // The Docbook XML file to render from (.manual.xml)
2323
'output:' => 'o:', // The output directory
24-
'outputfilename:' => 'F:', // The output filename (only useful for bightml/bigpdf)
24+
'outputfilename:' => 'F:', // The output filename (only useful for bightml)
2525
'partial:' => 'p:', // The ID to render (optionally ignoring its children)
2626
'skip:' => 's:', // The ID to skip (optionally skipping its children too)
2727
'verbose::' => 'v::', // Adjust the verbosity level

0 commit comments

Comments
 (0)