[DOC-CVS] [phd] master: Remove references to PDF from docs and code comments
[email protected] (Anna Filina via Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Anna Filina (afilina)
Committer: Gina Peter Banyard (Girgias)
Date: 2025-11-04T06:15:12Z
Commit: https://github.com/php/phd/commit/deb7d81c49cf54fa9bd2b26fa51705616d84c06f
Raw diff: https://github.com/php/phd/commit/deb7d81c49cf54fa9bd2b26fa51705616d84c06f.diff
Remove references to PDF from docs and code comments
Changed paths:
M README.md
M docs/phd-guide/phd-guide.xml
M phpdotnet/phd/Format.php
M phpdotnet/phd/Highlighter.php
M phpdotnet/phd/Highlighter/GeSHi.php
M phpdotnet/phd/Highlighter/GeSHi11x.php
M phpdotnet/phd/Options/Handler.php
Diff:
diff --git a/README.md b/README.md
index 998b0a6a..7520b753 100644
--- a/README.md
+++ b/README.md
@@ -166,7 +166,7 @@ you can write a custom syntax highlighter.
A syntax highlighter for PhD is nothing more than a simple PHP class
that has two methods: `factory` and `highlight`.
-`factory` is static, takes the format name (i.e. `pdf`, `xhtml`,
+`factory` is static, takes the format name (i.e. `xhtml`,
`troff`) as its only parameter and returns the highlighter instance object
for the given format. The method is called for each output format the
documentation is rendered to.
@@ -234,13 +234,6 @@ PhD currently supports the following output formats:
<tr>
<td rowspan="6"></td>
<td>howto</td>
- </tr>
- <tr>
- <td>pdf</td>
- </tr>
- <tr>
- <td>bigpdf</td>
- </tr>
<tr>
<td>kdevelop</td>
</tr>
diff --git a/docs/phd-guide/phd-guide.xml b/docs/phd-guide/phd-guide.xml
index 8e902aad..833595f6 100644
--- a/docs/phd-guide/phd-guide.xml
+++ b/docs/phd-guide/phd-guide.xml
@@ -14,7 +14,7 @@
<para>PhD is PHP's very own DocBook 5 rendering system. It is used to
convert the <acronym>PHP</acronym> Manual and PEAR Documentation into
- different output formats like XHTML, PDF, Man pages and CHM.</para>
+ different output formats like XHTML, Man pages and CHM.</para>
<para>The goal of PhD is to become a fast, general DocBook rendering
system. At the moment of writing, PhD is already very fast: It can create
@@ -261,8 +261,6 @@ Supported packages:
php
howto
manpage
- pdf
- bigpdf
kdevelop
chm
tocfeed
@@ -280,7 +278,7 @@ Supported packages:
<para>You can tell by the output of the <literal>--list</literal> option
- that PhD can also be used to render the docs as a PDF file, or as Unix
+ that PhD can also be used to render the docs as Unix
Man Pages.</para>
<para>To select a format and package, you must use the <literal>-f
@@ -645,7 +643,7 @@ $ pear install mediawiki/geshi]]></screen>
and <literal>highlight</literal>.</para>
<para><literal>factory</literal> is static and takes the format name
- (i.e. <literal>pdf</literal>, <literal>xhtml</literal>,
+ (i.e. <literal>xhtml</literal>,
<literal>troff</literal>) as only parameter. It returns
the highlighter instance object for the given format.
The method is called for each output format the documentation
diff --git a/phpdotnet/phd/Format.php b/phpdotnet/phd/Format.php
index 49b3ece4..2ac1d99d 100644
--- a/phpdotnet/phd/Format.php
+++ b/phpdotnet/phd/Format.php
@@ -512,7 +512,7 @@ public function rowspan($attrs) {
*
* @param string $text Text to highlight
* @param string $role Source code role to use (php, xml, html, ...)
- * @param string $format Format to highlight (pdf, xhtml, troff, ...)
+ * @param string $format Format to highlight (xhtml, troff, ...)
*
* @return string Highlighted code
*/
diff --git a/phpdotnet/phd/Highlighter.php b/phpdotnet/phd/Highlighter.php
index 4bff2b57..c59c18e7 100644
--- a/phpdotnet/phd/Highlighter.php
+++ b/phpdotnet/phd/Highlighter.php
@@ -29,7 +29,7 @@ class Highlighter
* We use a factory so you can return different objects/classes
* per format.
*
- * @param string $format Output format (pdf, xhtml, troff, ...)
+ * @param string $format Output format (xhtml, troff, ...)
*
* @return Highlighter Highlighter object
*/
@@ -47,7 +47,7 @@ public static function factory($format)
*
* @param string $text Text to highlight
* @param string $role Source code role to use (php, xml, html, ...)
- * @param string $format Output format (pdf, xhtml, troff, ...)
+ * @param string $format Output format (xhtml, troff, ...)
*
* @return string Highlighted code
*/
diff --git a/phpdotnet/phd/Highlighter/GeSHi.php b/phpdotnet/phd/Highlighter/GeSHi.php
index 28dbfe68..c8d01029 100644
--- a/phpdotnet/phd/Highlighter/GeSHi.php
+++ b/phpdotnet/phd/Highlighter/GeSHi.php
@@ -49,7 +49,7 @@ class Highlighter_GeSHi extends Highlighter
* We use a factory so you can return different objects/classes
* per format.
*
- * @param string $format Output format (pdf, xhtml, troff, ...)
+ * @param string $format Output format (xhtml, troff, ...)
*
* @return Highlighter Highlighter object
*/
@@ -71,7 +71,7 @@ public static function factory($format)
*
* @param string $text Text to highlight
* @param string $role Source code role to use (php, xml, html, ...)
- * @param string $format Output format (pdf, xhtml, troff, ...)
+ * @param string $format Output format (xhtml, troff, ...)
*
* @return string Highlighted code
*/
diff --git a/phpdotnet/phd/Highlighter/GeSHi11x.php b/phpdotnet/phd/Highlighter/GeSHi11x.php
index 5936582c..7c5abd0a 100644
--- a/phpdotnet/phd/Highlighter/GeSHi11x.php
+++ b/phpdotnet/phd/Highlighter/GeSHi11x.php
@@ -43,7 +43,7 @@ class Highlighter_GeSHi11x extends Highlighter
* We use a factory so you can return different objects/classes
* per format.
*
- * @param string $format Output format (pdf, xhtml, troff, ...)
+ * @param string $format Output format (xhtml, troff, ...)
*
* @return Highlighter Highlighter object
*/
@@ -89,7 +89,7 @@ public function __construct(\GeSHiRenderer $renderer)
*
* @param string $text Text to highlight
* @param string $role Source code role to use (php, xml, html, ...)
- * @param string $format Output format (pdf, xhtml, troff, ...)
+ * @param string $format Output format (xhtml, troff, ...)
*
* @return string Highlighted code
*/
diff --git a/phpdotnet/phd/Options/Handler.php b/phpdotnet/phd/Options/Handler.php
index 57ed16ae..a2656227 100644
--- a/phpdotnet/phd/Options/Handler.php
+++ b/phpdotnet/phd/Options/Handler.php
@@ -15,13 +15,13 @@ public function __construct(
public function optionList(): array
{
return [
- 'format:' => 'f:', // The format to render (xhtml, pdf...)
+ 'format:' => 'f:', // The format to render (xhtml, troff...)
'noindex' => 'I', // Do not re-index
'forceindex' => 'r', // Force re-indexing under all circumstances
'notoc' => 't', // Do not re-create TOC
'docbook:' => 'd:', // The Docbook XML file to render from (.manual.xml)
'output:' => 'o:', // The output directory
- 'outputfilename:' => 'F:', // The output filename (only useful for bightml/bigpdf)
+ 'outputfilename:' => 'F:', // The output filename (only useful for bightml)
'partial:' => 'p:', // The ID to render (optionally ignoring its children)
'skip:' => 's:', // The ID to skip (optionally skipping its children too)
'verbose::' => 'v::', // Adjust the verbosity level