Creating the PDF

The pdf of the document can be created from the print version (_print.html).

  1. Create two pdfs of _print.html, one for Letter size named videoray_doc_projectName.pdf, and one for A4 size named videoray_doc_projectName_a4.pdf, in the staged project's pdf folder. If working with a document for which the script is automatically generated (VITAL, Parts Navigator, etc.), the projectName should be preceded by an extra "_" because the script is automatically generated and includes the "_" prefix, such as _productName.

  2. >Review the pdf for errors, and check to ensure that the pdf link in side bar of the "About this Document" page (intro_about.html) works (using the staged location).

Any relative URL links in the document must be addressed. There are two options:

  1. Since many links in a typical document are relative, links in the pdf will be based upon the server path where the file is located. If the document is located in a server/path where the relative links can be resolved, the pdf should be created using the _print.html file on that server/path. Otherwise the links will resolve to the source server/path where the file is located when the pdf is created, and if this is localhost/, the the links will not work properly when published. An issue with this method is that internal links will typically have an html page as the target and not link to the expected location within the pdf.

  2. Remove all relative links from the print version using <--v--> <--/v--> around the <a href=""> and </a> tags.

Document Creation Manual, Version: 1.00.00
Copyright © 2022, VideoRay LLC - The Global Leader in Micro-ROV Technology