Once the plug-in is installed, any URL that a server serves as MIME types image/cpi, image/tiff, or image/pbm will be viewed using the plug-in. You should configure your Web server to serve files with .cpi and .cpc extensions as image/cpi, with .tif or .tiff extensions as image/tiff, and with .pbm extensions as image/pbm. Consult the documentation for your server to determine how to perform this configuration.
URLs to documents served as any of these MIME types are specified as usual, using the <a> tag. For instance,
Additional functionality is available by adding to the URLs information about how to configure the viewer when the link is selected. These options are added to the URL following a '#' sign and are separated by semicolons.
Due to limitations in Internet Explorer's emulation of the plugin environment, the plugin does not receive extended URL parameters specified with the '#' syntax when running under Internet Explorer. As of CPC View V4.3, CPC View will also accept an alternate syntax in which the url is separated from the parameters by a '?' rather than a '#' (e.g., "abc.tiff?strict;controls=!all,zoom,mouse,scrollpad"). The '?' syntax will work in both Internet Explorer and Netscape.
The named values (white, lightgray, darkgray, black) are the four tones of gray adjusted by the current desktop color scheme. So, depending on the color scheme you have chosen, black may not equal 000000.
Values can be separated by either commas (",") or plus signs ("+"). The "+" separator can be used to control the order of the widgets on the tool bar. The controls are added in groups defined by the "+" separator. All of the controls in a group to the left of a "+" will be to the left (or above) the controls on the right of the "+". The ordering of controls within a comma-separated group is undefined, so if you care about the order, you should separate all of the controls with "+".
For example, the specification
A side effect is that user preference changes made to a view of a "strict" url are not saved.
At the right is another example that puts up a particular page from the document above. The following HTML was used: These embedded images are "live"; all the standard user interface techniques work as usual. (Go ahead. Try it!) Meta-Documents A meta-document is a composite image document comprising one or more image document fragments. Each fragment consists of a contiguous range of pages from within some underlying image document. The viewer treats a meta-document exactly as if it were a single image document containing the concatenation of all of the pages contained in all of the fragments. Note: Meta-documents require version 5.6 (or later) of CPC View, CPC Lite, or CPC View ax. XML Description A meta-document is described by an XML file. Currently, there is no DTD. To satisfy the well-formedness requirements for DTD-less XML, the entire meta-document should be enclosed in a <metadoc> block: <?xml version="1.0" ?> <metadoc> list of meta-document fragments </metadoc> Note: The viewer does not check whether the XML is well-formed. That is, the viewer will accept XML files that do not enclose the fragments in a <metadoc> block. Fragments A fragment is described by the empty <frag> tag. The tag requires two attributes: the URL of the underlying image document (url) and the number of pages to include from the underlying image document (numpages). <frag url="http://foobar.com/doc1.cpc" numpages="3" /> The url must be specified as an absolute url; relative urls are not accepted. The url can specify any of the following transports: http, https, ftp, and file. The underlying image document pointed to by url can be in any file format supported by the viewer, with the exception that it can not itself be a meta-document or an annotation file that links to its underlying image file. If numpages is fewer than the actual number of pages in the underlying image document, only the specified number of pages are included in the fragment. If numpages exceeds the actual number of pages in the underlying image document, the viewer displays the extra pages with errors. The order of the <frag> tags is significant; it defines the order that the pages appear in the meta-document. Example Consider the following XML meta-document description: <?xml version="1.0" ?> <metadoc> <frag url="file://e:/cabs/300dpi/FaxTest-300.tiff" numpages="2" /> <frag url="https://www.cartesianinc.com/Demo/TiffStreams/Gilman2.tiff" numpages="3" /> <frag url="http://www.cartesianinc.com/Demo/CPCStreams/Gilman2.cpc" numpages="1" /> <frag url="http://www.cartesianinc.com/Demo/TiffStreams/Angeles.tiff" numpages="8" /> </metadoc> This example describes a 14 page meta-document with the following structure: Meta-document pages Fragment image document Fragment pages 1-2 e:/cabs/300dpi/FaxTest-300.tiff (local file) 1-2 3-5 https://www.cartesianinc.com/Demo/TiffStreams/Gilman2.tiff 1-3 6 http://www.cartesianinc.com/Demo/CPCStreams/Gilman2.cpc 1 7-14 http://www.cartesianinc.com/Demo/TiffStreams/Angeles.tiff 1-8 Batch Printing A batch print job is a list of one or more image documents that are to be printed. When a batch print job is opened, the viewer queries the user for the print parameters to apply to the job. The specified print parameters are applied to each of the documents in the job. Once the user has specified the print parameters, the viewer automatically downloads and prints each document without further user interaction. As with normal printing operations, while the batch job is printing, a status window displays the current status of the job. The status window also contains a Cancel button that can be used to terminate the batch print job. If an error occurs during a print job, the user is queried as to whether or not the remaining documents in the job should be printed. The viewer does not display the documents in the print job. It merely prints them. Note: Batch print jobs require version 5.7 (or later) of CPC View, CPC Lite, or CPC View ax. To simplify the detection of clients with older versions of the viewer, a new mime-type is supported, application/cpi-job. XML Description A batch print job is described by an XML file. Currently, there is no DTD. Tag: batchprint The entire batch print job must be enclosed in a <batchprint> block: <?xml version="1.0" ?> <batchprint oncomplete="javascript:close()"> list of documents to print </batchprint> The tag accepts an optional oncomplete attribute. If specified, it is the URL to open in the browser on completion of the batch print operation. Note that the oncomplete can be a javascript url, to allow for the execution of completion scripts on the page that embeds the print job. Tag: doc Each document in the job is described by the empty <doc> tag. The order of the <doc> tags is significant; it defines the order in which the documents are printed. <doc url="http://foobar.com/doc1.cpc" title="Hello, World" /> The tag requires one attribute: the URL of the underlying image document (url). The url must be specified as an absolute url; relative urls are not accepted. The url can specify any of the following transports: http, https, ftp, and file. The underlying image document pointed to by url can be in any file format supported by the viewer, with the exception that it can not itself be a batch print job or an annotation file that links to its underlying image file. The tag accepts an optional title attribute. If specified, it is used as the title for the document. If not specified, the url of the document is used as the title. Example Consider the following XML batch print job description: <?xml version="1.0" ?> <batchprint oncomplete="http://foobar.com/PrintDone.html"> <doc url="file://e:/cabs/300dpi/FaxTest-300.tiff" title="Local Test" /> <doc url="http://foobar.com/Demo/CPCStreams/Gilman2.cpc" /> <doc url="https://foobar.com/Demo/TiffStreams/Gilman2.tiff" title="Gilman (https)" /> </batchprint> This example describes a 3 document batch print job. The following actions occur when the job is opened: A Select batch print options window is opened, allowing the user to specify the printing options to apply to the document. (The user can also cancel the print job.) The local document at e:/cabs/300dpi/FaxTest-300.tiff is printed with the title Local Test. The remote document at http://foobar.com/Demo/CPCStreams/Gilman2.cpc is printed. Since no title is specified, the document's url will be used as the title. The remote document at https://foobar.com/Demo/TiffStreams/Gilman2.tiff is printed with the title Gilman (https). The document at http://foobar.com/PrintDone.html is opened in the host browser. Batch Downloading A batch download job is a list of one or more documents that are to be downloaded. When a batch download job is opened, the viewer queries the user for the folder in which to save the downloaded documents. The viewer then automatically downloads each of the listed documents into the specified folder without further user interaction. If any of the listed documents already exist in the specified folder, the user is queried as to whether the existing documents should be skipped. While the batch job is downloading, a status window displays the current status of the job. The status window also contains a Cancel button that can be used to terminate the batch download job. If an error occurs during a download job, the user is queried as to whether or not the remaining documents in the job should be downloaded. The viewer does not display the documents in the download job. It merely downloads them. Note: Batch print jobs require version 5.8 (or later) of CPC View, CPC Lite, or CPC View ax. To simplify the detection of clients with older versions of the viewer, a new mime-type is supported, application/cpi-download. The documents to download need not be image documents. The viewer downloads exact copies of the listed documents and is ignorant of the underlying file format. XML Description A batch download job is described by an XML file. Currently, there is no DTD. Tag: batchdownload The entire batch download job must be enclosed in a <batchdownload> block: <?xml version="1.0" ?> <batchdownload oncomplete="javascript:close()"> list of documents to download </batchdownload> The tag accepts an optional oncomplete attribute. If specified, it is the URL to open in the browser on completion of the batch download operation. Note that the oncomplete can be a javascript url, to allow for the execution of completion scripts on the page that embeds the download job. Tag: doc Each document in the job is described by the empty <doc> tag. The order of the <doc> tags is significant; it defines the order in which the documents are downloaded. <doc url="http://foobar.com/doc1.cpc" title="Hello, World" filename="file1.download"/> The tag requires one attribute: the URL of the underlying document (url). The url must be specified as an absolute url; relative urls are not accepted. The url can specify any of the following transports: http, https, ftp, and file. The tag accepts an optional filename attribute. If specified, it is used as the filename for the downloaded document. If not specified, the last component of the url is used as the filename. The tag accepts an optional title attribute. If specified, it is used as the title for the document. If not specified, the url of the document is used as the title. The title of the current document is displayed in the download status window. Example Consider the following XML batch download job description: <?xml version="1.0" ?> <batchdownload oncomplete="http://foobar.com/DownloadDone.html"> <doc url="file://e:/cabs/300dpi/FaxTest-300.tiff" /> <doc url="http://foobar.com/Demo/CPCStreams/Gilman2.cpc" /> <doc url="https://foobar.com/Gilman2.txt" title="Gilman (text)" filename="foo.txt"/> </batchdownload> This example describes a 3 document batch download job. The following actions occur when the job is opened: A Select the folder in which to save the downloaded documents window is opened, allowing the user to select the folder in which to save the downloaded documents. (The user can also cancel the download job.) The local document at e:/cabs/300dpi/FaxTest-300.tiff is copied into the selected folder under the name FaxTest-300.tiff. The remote document at http://foobar.com/Demo/CPCStreams/Gilman2.cpc is downloaded and saved into the selected folder under the name Gilman2.cpc. The remote document at https://foobar.com/Gilman2.txt is downloaded and saved into the selected folder under the name foo.txt. During the download, the download status window displays the title Gilman (text). The document at http://foobar.com/DownloadDone.html is opened in the host browser. © 1998-2001 Cartesian Products, Inc. Contact Cartesian
These embedded images are "live"; all the standard user interface techniques work as usual. (Go ahead. Try it!)
Note: Meta-documents require version 5.6 (or later) of CPC View, CPC Lite, or CPC View ax.
<?xml version="1.0" ?> <metadoc> list of meta-document fragments </metadoc>
list of meta-document fragments
<frag url="http://foobar.com/doc1.cpc" numpages="3" />
If numpages is fewer than the actual number of pages in the underlying image document, only the specified number of pages are included in the fragment. If numpages exceeds the actual number of pages in the underlying image document, the viewer displays the extra pages with errors.
The order of the <frag> tags is significant; it defines the order that the pages appear in the meta-document.
<?xml version="1.0" ?> <metadoc> <frag url="file://e:/cabs/300dpi/FaxTest-300.tiff" numpages="2" /> <frag url="https://www.cartesianinc.com/Demo/TiffStreams/Gilman2.tiff" numpages="3" /> <frag url="http://www.cartesianinc.com/Demo/CPCStreams/Gilman2.cpc" numpages="1" /> <frag url="http://www.cartesianinc.com/Demo/TiffStreams/Angeles.tiff" numpages="8" /> </metadoc>
<frag url="file://e:/cabs/300dpi/FaxTest-300.tiff" numpages="2" /> <frag url="https://www.cartesianinc.com/Demo/TiffStreams/Gilman2.tiff" numpages="3" /> <frag url="http://www.cartesianinc.com/Demo/CPCStreams/Gilman2.cpc" numpages="1" /> <frag url="http://www.cartesianinc.com/Demo/TiffStreams/Angeles.tiff" numpages="8" />
This example describes a 14 page meta-document with the following structure:
Meta-document pages Fragment image document Fragment pages 1-2 e:/cabs/300dpi/FaxTest-300.tiff (local file) 1-2 3-5 https://www.cartesianinc.com/Demo/TiffStreams/Gilman2.tiff 1-3 6 http://www.cartesianinc.com/Demo/CPCStreams/Gilman2.cpc 1 7-14 http://www.cartesianinc.com/Demo/TiffStreams/Angeles.tiff 1-8
As with normal printing operations, while the batch job is printing, a status window displays the current status of the job. The status window also contains a Cancel button that can be used to terminate the batch print job.
If an error occurs during a print job, the user is queried as to whether or not the remaining documents in the job should be printed.
The viewer does not display the documents in the print job. It merely prints them.
Note: Batch print jobs require version 5.7 (or later) of CPC View, CPC Lite, or CPC View ax. To simplify the detection of clients with older versions of the viewer, a new mime-type is supported, application/cpi-job.
<?xml version="1.0" ?> <batchprint oncomplete="javascript:close()"> list of documents to print </batchprint>
list of documents to print
<doc url="http://foobar.com/doc1.cpc" title="Hello, World" />
The tag accepts an optional title attribute. If specified, it is used as the title for the document. If not specified, the url of the document is used as the title.
<?xml version="1.0" ?> <batchprint oncomplete="http://foobar.com/PrintDone.html"> <doc url="file://e:/cabs/300dpi/FaxTest-300.tiff" title="Local Test" /> <doc url="http://foobar.com/Demo/CPCStreams/Gilman2.cpc" /> <doc url="https://foobar.com/Demo/TiffStreams/Gilman2.tiff" title="Gilman (https)" /> </batchprint>
<doc url="file://e:/cabs/300dpi/FaxTest-300.tiff" title="Local Test" /> <doc url="http://foobar.com/Demo/CPCStreams/Gilman2.cpc" /> <doc url="https://foobar.com/Demo/TiffStreams/Gilman2.tiff" title="Gilman (https)" />
This example describes a 3 document batch print job. The following actions occur when the job is opened:
If any of the listed documents already exist in the specified folder, the user is queried as to whether the existing documents should be skipped.
While the batch job is downloading, a status window displays the current status of the job. The status window also contains a Cancel button that can be used to terminate the batch download job.
If an error occurs during a download job, the user is queried as to whether or not the remaining documents in the job should be downloaded.
The viewer does not display the documents in the download job. It merely downloads them.
Note: Batch print jobs require version 5.8 (or later) of CPC View, CPC Lite, or CPC View ax. To simplify the detection of clients with older versions of the viewer, a new mime-type is supported, application/cpi-download.
The documents to download need not be image documents. The viewer downloads exact copies of the listed documents and is ignorant of the underlying file format.
<?xml version="1.0" ?> <batchdownload oncomplete="javascript:close()"> list of documents to download </batchdownload>
list of documents to download
<doc url="http://foobar.com/doc1.cpc" title="Hello, World" filename="file1.download"/>
The tag accepts an optional filename attribute. If specified, it is used as the filename for the downloaded document. If not specified, the last component of the url is used as the filename.
The tag accepts an optional title attribute. If specified, it is used as the title for the document. If not specified, the url of the document is used as the title. The title of the current document is displayed in the download status window.
<?xml version="1.0" ?> <batchdownload oncomplete="http://foobar.com/DownloadDone.html"> <doc url="file://e:/cabs/300dpi/FaxTest-300.tiff" /> <doc url="http://foobar.com/Demo/CPCStreams/Gilman2.cpc" /> <doc url="https://foobar.com/Gilman2.txt" title="Gilman (text)" filename="foo.txt"/> </batchdownload>
<doc url="file://e:/cabs/300dpi/FaxTest-300.tiff" /> <doc url="http://foobar.com/Demo/CPCStreams/Gilman2.cpc" /> <doc url="https://foobar.com/Gilman2.txt" title="Gilman (text)" filename="foo.txt"/>
This example describes a 3 document batch download job. The following actions occur when the job is opened: