]> git.ipfire.org Git - thirdparty/cups.git/commitdiff
Fix HTML errors in documentation (using swish-e to validate HTML...)
authormsweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be>
Wed, 3 Jul 2013 14:26:55 +0000 (14:26 +0000)
committermsweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be>
Wed, 3 Jul 2013 14:26:55 +0000 (14:26 +0000)
git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11087 a1ca3aef-8c08-0410-bb20-df032aa958be

12 files changed:
cups/api-cups.shtml
cups/api-filter.shtml
doc/help/api-cups.html
doc/help/api-filter.html
doc/help/api-raster.html
doc/help/network.html
doc/help/ref-subscriptions-conf.html
doc/help/security.html
doc/help/spec-ppd.html
doc/swish-e.config [new file with mode: 0644]
filter/api-raster.shtml
filter/spec-ppd.shtml

index e60d03d75764d841f7376e3f2b40b4db30a68393..caa96b953366dd197aa9f0786db4f3a48826e4cd 100644 (file)
@@ -3,7 +3,7 @@
 
   API introduction for CUPS.
 
-  Copyright 2007-2011 by Apple Inc.
+  Copyright 2007-2013 by Apple Inc.
   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 
   These coded instructions, statements, and computer programs are the
@@ -183,7 +183,7 @@ int num_options = 0;
 <a href='#cups_option_t'>cups_option_t</a> *options = NULL;
 <a href='#cups_dest_t'>cups_dest_t</a> *dest;
 
-for (i = 0; i < dest->num_options; i ++)
+for (i = 0; i &lt; dest->num_options; i ++)
   num_options = <a href='#cupsAddOption'>cupsAddOption</a>(dest->options[i].name, dest->options[i].value,
                               num_options, &amp;options);
 </pre>
@@ -235,7 +235,7 @@ job_id = <a href='#cupsPrintFiles'>cupsPrintFiles</a>(dest->name, 3, files, "Tes
 
 <p>Finally, the <a href='#cupsCreateJob'><code>cupsCreateJob</code></a>
 function creates a new job with no files in it. Files are added using the
-<a href='#cupsStartDocument'><code>cupsStartDocument</code></a>, 
+<a href='#cupsStartDocument'><code>cupsStartDocument</code></a>,
 <a href='api-httpipp.html#cupsWriteRequestData'><code>cupsWriteRequestData</code></a>,
 and <a href='#cupsFinishDocument'><code>cupsFinishDocument</code></a> functions.
 The following example creates a job with 10 text files for printing:</p>
@@ -299,7 +299,7 @@ int num_jobs;
 <a href='#cups_job_t'>cups_job_t</a> *jobs;
 int i;
 ipp_jstate_t job_state = IPP_JOB_PENDING;
+
 while (job_state &lt; IPP_JOB_STOPPED)
 {
   /* Get my jobs (1) with any state (-1) */
index e95c8d08f12bc2f66da5fb30a930c3e8c644f8a2..3f912ba8644738786a0faf72d907acea8b4a1673 100644 (file)
@@ -3,7 +3,7 @@
 
   Filter and backend programming introduction for CUPS.
 
-  Copyright 2007-2012 by Apple Inc.
+  Copyright 2007-2013 by Apple Inc.
   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 
   These coded instructions, statements, and computer programs are the
@@ -488,7 +488,7 @@ from localizing the vendor-prefixed keyword in the PPD file - otherwise both
 the generic and vendor-specific keyword will be shown in the user
 interface.</p>
 
-</blockquote></dd>
+</blockquote>
 
 <h4><a name="REPORTING_SUPPLIES">Reporting Supply Levels</a></h4>
 
@@ -613,7 +613,7 @@ datalen = sizeof(data) - 1;
 status = <a href="#cupsSideChannelDoRequest">cupsSideChannelDoRequest</a>(CUPS_SC_CMD_GET_DEVICE_ID, data, &amp;datalen, 1.0);
 
 /* Use the returned value if OK was returned and the length is non-zero */
-if (status == CUPS_SC_STATUS_OK && datalen > 0)
+if (status == CUPS_SC_STATUS_OK &amp;&amp; datalen > 0)
   data[datalen] = '\0';
 else
   data[0] = '\0';
index d5635c6f3c560b1879a492260eb093e7ffdf790d..b355e108bc35d45855068cb64e17d8b4a3a1994b 100644 (file)
@@ -551,7 +551,7 @@ constants">cups_ptype_e</a></li>
 
   API introduction for CUPS.
 
-  Copyright 2007-2011 by Apple Inc.
+  Copyright 2007-2013 by Apple Inc.
   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 
   These coded instructions, statements, and computer programs are the
@@ -731,7 +731,7 @@ int num_options = 0;
 <a href='#cups_option_t'>cups_option_t</a> *options = NULL;
 <a href='#cups_dest_t'>cups_dest_t</a> *dest;
 
-for (i = 0; i < dest->num_options; i ++)
+for (i = 0; i &lt; dest->num_options; i ++)
   num_options = <a href='#cupsAddOption'>cupsAddOption</a>(dest->options[i].name, dest->options[i].value,
                               num_options, &amp;options);
 </pre>
@@ -783,7 +783,7 @@ job_id = <a href='#cupsPrintFiles'>cupsPrintFiles</a>(dest->name, 3, files, "Tes
 
 <p>Finally, the <a href='#cupsCreateJob'><code>cupsCreateJob</code></a>
 function creates a new job with no files in it. Files are added using the
-<a href='#cupsStartDocument'><code>cupsStartDocument</code></a>, 
+<a href='#cupsStartDocument'><code>cupsStartDocument</code></a>,
 <a href='api-httpipp.html#cupsWriteRequestData'><code>cupsWriteRequestData</code></a>,
 and <a href='#cupsFinishDocument'><code>cupsFinishDocument</code></a> functions.
 The following example creates a job with 10 text files for printing:</p>
@@ -847,7 +847,7 @@ int num_jobs;
 <a href='#cups_job_t'>cups_job_t</a> *jobs;
 int i;
 ipp_jstate_t job_state = IPP_JOB_PENDING;
+
 while (job_state &lt; IPP_JOB_STOPPED)
 {
   /* Get my jobs (1) with any state (-1) */
index 5888e4cd828d35fc654012ef66c790f7e2a68acb..54280587924f1b3de79da0566a5ec312235aafdf 100644 (file)
@@ -430,7 +430,7 @@ div.contents ul.subcontents li {
 
   Filter and backend programming introduction for CUPS.
 
-  Copyright 2007-2012 by Apple Inc.
+  Copyright 2007-2013 by Apple Inc.
   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 
   These coded instructions, statements, and computer programs are the
@@ -915,7 +915,7 @@ from localizing the vendor-prefixed keyword in the PPD file - otherwise both
 the generic and vendor-specific keyword will be shown in the user
 interface.</p>
 
-</blockquote></dd>
+</blockquote>
 
 <h4><a name="REPORTING_SUPPLIES">Reporting Supply Levels</a></h4>
 
@@ -1040,7 +1040,7 @@ datalen = sizeof(data) - 1;
 status = <a href="#cupsSideChannelDoRequest">cupsSideChannelDoRequest</a>(CUPS_SC_CMD_GET_DEVICE_ID, data, &amp;datalen, 1.0);
 
 /* Use the returned value if OK was returned and the length is non-zero */
-if (status == CUPS_SC_STATUS_OK && datalen > 0)
+if (status == CUPS_SC_STATUS_OK &amp;&amp; datalen > 0)
   data[datalen] = '\0';
 else
   data[0] = '\0';
index 706d1eb027ea8f88e56d94c63ea24907b02bdf22..f2dade43cdaf8f8d6335262165587cd72786fb74 100644 (file)
@@ -438,7 +438,7 @@ page header structure.">cupsRasterWriteHeader2</a></li>
 
   Raster API introduction for CUPS.
 
-  Copyright 2007-2012 by Apple Inc.
+  Copyright 2007-2013 by Apple Inc.
   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 
   These coded instructions, statements, and computer programs are the
@@ -653,7 +653,7 @@ requested attributes cannot be supported.<br>
 <br>
 
 <code>cupsRasterInterpretPPD</code> supports a subset of the PostScript language.
-Currently only the <code>[</code>, <code>]</code>, <code><<</code>, <code>>></code>, <code>{</code>,
+Currently only the <code>[</code>, <code>]</code>, <code>&lt;&lt;</code>, <code>&gt;&gt;</code>, <code>{</code>,
 <code>}</code>, <code>cleartomark</code>, <code>copy</code>, <code>dup</code>, <code>index</code>,
 <code>pop</code>, <code>roll</code>, <code>setpagedevice</code>, and <code>stopped</code> operators
 are supported.
index ef9fbefbebdaf2878ebe54001d1cb2975cad1d66..21112f693fe9a7b39952672861ad9a464e59924c 100644 (file)
@@ -88,10 +88,10 @@ page on the device.</P>
 <PRE>
 socket://<i>ip-address-or-hostname</i>
 socket://<i>ip-address-or-hostname</i>/?option=value
-socket://<i>ip-address-or-hostname</i>/?option=value&option=value
+socket://<i>ip-address-or-hostname</i>/?option=value&amp;option=value
 socket://<i>ip-address-or-hostname</i>:<i>port-number</i>
 socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value
-socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value&option=value
+socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value&amp;option=value
 </PRE>
 
 <P>The "contimeout" option controls the number of seconds that the backend will wait to obtain a connection to the printer. The default is 1 week.</P>
@@ -107,19 +107,19 @@ socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value&option=v
 <PRE>
 http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
 http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
-http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
+http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&amp;option=value</i>
 ipp://<i>ip-address-or-hostname</i>/<i>resource</i>
 ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value</i>
-ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&option=value</i>
+ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&amp;option=value</i>
 ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
 ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
-ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
+ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&amp;option=value</i>
 ipps://<i>ip-address-or-hostname</i>/<i>resource</i>
 ipps://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value</i>
-ipps://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&option=value</i>
+ipps://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&amp;option=value</i>
 ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
 ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
-ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
+ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&amp;option=value</i>
 </PRE>
 
 <P>The <tt>ipp</tt> backend supports many options, which are summarized in <A HREF="#TABLE2">Table 2</A>.</P>
@@ -189,8 +189,8 @@ lpd://<i>ip-address-or-hostname</i>/<i>queue</i>
 lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>
 lpd://<i>ip-address-or-hostname</i>/<i>queue</i>?<i>option=value</i>
 lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>?<i>option=value</i>
-lpd://<i>ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&option=value</i>
-lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&option=value</i>
+lpd://<i>ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&amp;option=value</i>
+lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&amp;option=value</i>
 </PRE>
 
 <P><A HREF="#TABLE3">Table 3</A> summarizes the options supported by the <tt>lpd</tt> backend.</P>
@@ -436,7 +436,7 @@ CUPS_DEBUG_LEVEL=2 /usr/lib/cups/backend/snmp 2>&amp;1 | tee snmp.log
 <P>For C shell (/bin/csh) and TCsh (/bin/tcsh), use the following command instead:</P>
 
 <PRE CLASS="command">
-(setenv CUPS_DEBUG_LEVEL 2; /usr/lib/cups/backend/snmp) |& tee snmp.log
+(setenv CUPS_DEBUG_LEVEL 2; /usr/lib/cups/backend/snmp) |&amp; tee snmp.log
 </PRE>
 
 <P>On MacOS X you'll find the SNMP backend in /usr/libexec/cups/backend instead:</P>
index d4f4defc339af8060a0fdc41419646f9268f094d..06cfc72c4122e0167284cfabb8ffa360a8fe7104 100644 (file)
@@ -196,7 +196,7 @@ HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>
 <PRE CLASS="command">
 &lt;Subscription NNN&gt;
   ...
-  LeaseDuration 
+  LeaseDuration
 &lt;/Subscription&gt;
 </PRE>
 
@@ -335,17 +335,17 @@ unique (to the server) number starting at 1.</P>
 <PRE CLASS="command">
 &lt;Subscription NNN&gt;
   ...
-  UserData mailto:bar<40>domain.com
+  UserData mailto:bar&lt;40&gt;example.com
 &lt;/Subscription&gt;
 </PRE>
 
 <H3>Description</H3>
 
 <P>The <CODE>UserData</CODE> directive specifies the
-<CODE>notify-user-data</CODE> value, which is normally the "from"
+<CODE>notify-user-data</CODE> value, which is normally the "to"
 address used in <CODE>mailto</CODE> notifications. Binary values
 are introduced by encoding the bytes as hexadecimal values inside
-angle brackets, e.g. "<1234>".</P>
+angle brackets, e.g. "&lt;1234&gt;".</P>
 
 <P>The <CODE>UserData</CODE> directive must appear inside a <A
 HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>
index c86151d176f1ba6a67d9f21fa34e91d53ff14cd0..3bd5642536771b838a22ba0fb1228e1d31aba193 100644 (file)
@@ -48,7 +48,7 @@ authentication:</P>
        middle" and replay attacks from the same client.</P>
 
        <P><B>Recommendation:</B> Enable encryption to hide the
-       username and password information.</P></LI></LI>
+       username and password information.</P></LI>
 
        <LI>Local certificate authentication passes 128-bit
        "certificates" that identify an authenticated user.
@@ -65,7 +65,7 @@ authentication:</P>
        socket.</P>
 
        <P><B>Recommendation:</B> Ensure that unauthorized users
-       are not added to the system group(s).</P></LI></LI>
+       are not added to the system group(s).</P></LI>
 
 </OL>
 
index d68b67c3f39cf6a2aa9ea1eec3f64c2e274c209d..5853ede5faec924e35cef1d9347e0bc822a25658 100644 (file)
@@ -975,7 +975,7 @@ option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234"
 
 <p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p>
 
-<h3>Custom Page Size Code</a></h3>
+<h3>Custom Page Size Code</h3>
 
 <p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p>
 
@@ -988,7 +988,7 @@ option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234"
 *CustomPageSize True: "pop pop pop &lt;&lt;/PageSize[5 -2 roll]/ImagingBBox null&gt;&gt;setpagedevice"
 </pre>
 
-<h3>Supported PostScript Operators</a></h3>
+<h3>Supported PostScript Operators</h3>
 
 <p>CUPS supports the following PostScript operators in addition to the usual PostScript number, string (literal and hex-encoded), boolean, null, and name values:</p>
 
@@ -1047,7 +1047,7 @@ PRE B {
 
 </blockquote>
 
-<h3>Supported Page Device Attributes</a></h3>
+<h3>Supported Page Device Attributes</h3>
 
 <p>Table 2 shows the supported page device attributes along with PostScript code examples.</p>
 
@@ -2327,7 +2327,7 @@ the device.</p>
 
 <ul>
 
-    <li>Added <a href="#cupsPageSizeCategory"><tt>cupsPageSizeCategory</tt></a> keyword (originally defined in CUPS 1.4).</li>
+       <li>Added <a href="#cupsPageSizeCategory"><tt>cupsPageSizeCategory</tt></a> keyword (originally defined in CUPS 1.4).</li>
 
        <li>Added <a href="#cupsMaxCopies"><tt>cupsMaxCopies</tt></a> keyword.</li>
 
diff --git a/doc/swish-e.config b/doc/swish-e.config
new file mode 100644 (file)
index 0000000..662f983
--- /dev/null
@@ -0,0 +1,16 @@
+# Where to get things
+IndexDir doc
+
+# Where to put things
+IndexFile doc/swish-e.index
+
+# Ignore image and index files
+FileRules filename contains .gif
+FileRules filename contains .gz
+FileRules filename contains .jpg
+FileRules filename contains .png
+FileRules filename contains .svg
+FileRules filename contains swish-e
+FileRules filename contains .tokens
+FileRules filename is Makefile
+
index fff478dcfeabe3215cfafcaecb466eeb73fa904a..cb137d525fa2a55c34da3ceb0c8243ceeb8c9ec3 100644 (file)
@@ -3,7 +3,7 @@
 
   Raster API introduction for CUPS.
 
-  Copyright 2007-2012 by Apple Inc.
+  Copyright 2007-2013 by Apple Inc.
   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 
   These coded instructions, statements, and computer programs are the
index 756315137faf481972c3ae099c8fe75c710c02b8..33c2d5791f6a5d0353b97aec24b314f0b140aeb9 100644 (file)
@@ -529,7 +529,7 @@ option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234"
 
 <p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p>
 
-<h3>Custom Page Size Code</a></h3>
+<h3>Custom Page Size Code</h3>
 
 <p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p>
 
@@ -542,7 +542,7 @@ option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234"
 *CustomPageSize True: "pop pop pop &lt;&lt;/PageSize[5 -2 roll]/ImagingBBox null&gt;&gt;setpagedevice"
 </pre>
 
-<h3>Supported PostScript Operators</a></h3>
+<h3>Supported PostScript Operators</h3>
 
 <p>CUPS supports the following PostScript operators in addition to the usual PostScript number, string (literal and hex-encoded), boolean, null, and name values:</p>
 
@@ -601,7 +601,7 @@ PRE B {
 
 </blockquote>
 
-<h3>Supported Page Device Attributes</a></h3>
+<h3>Supported Page Device Attributes</h3>
 
 <p>Table 2 shows the supported page device attributes along with PostScript code examples.</p>
 
@@ -1881,7 +1881,7 @@ the device.</p>
 
 <ul>
 
-    <li>Added <a href="#cupsPageSizeCategory"><tt>cupsPageSizeCategory</tt></a> keyword (originally defined in CUPS 1.4).</li>
+       <li>Added <a href="#cupsPageSizeCategory"><tt>cupsPageSizeCategory</tt></a> keyword (originally defined in CUPS 1.4).</li>
 
        <li>Added <a href="#cupsMaxCopies"><tt>cupsMaxCopies</tt></a> keyword.</li>