Help:PDF Book - Revision history

Anw at 11:32, 27 February 2017

2017-02-27T11:32:45Z

← Older revision		Revision as of 13:32, 27 February 2017
Line 1:		Line 1:
	This page is intended to help with the automated production of PDF Books from the Assist pages.		This page is intended to help with the automated production of PDF Books from the Assist pages.

			== Creation of the Pages ==

			Use the Help/Creating new pages from templates link to create a new page.

			Name the page as you would like the title to appear in the final produced document.

			The page will be produced from a template, which will show all of the required sections.

			Do not repeat functionality in every page - if the same functionality is present in each page, consider moving this to a sub-section (i.e. overview, common features, etc) and potentially referencing them in the help page.

			e.g.

			'''Common Features'''
			* Searching and Filtering
			* Editing and Viewing through the Right Panel
			* Sorting Data


			Categorise all pages using the Category keyword at the bottom of the page.

			For example.

			The Vehicle Types page belongs to Maintenance, Vehicle Data and CTL-TMS Reference Guide.

			Base this categorisation off the basic menu structure - this will form the structure of documents produced from the Assist pages.

			The numbering of these sections will order the items within the category and on the document itself. If it is reasonable that the page would be sequenced alphabetically, omit the number or use the PAGENAME keyword as shown in the examples.

			Also consider using the Incomplete category so that pages that are not yet complete can be easily recognised and edited later.



	==Creation of the book==		==Creation of the book==

Anw: /* Production */

2017-02-20T11:27:10Z

Production

← Older revision		Revision as of 13:27, 20 February 2017
Line 29:		Line 29:

	==Production==		==Production==
	Click the link on the category entry created above, or amend the Category URL in the browser as follows:		Click the link on the category entry created above, or the link in the toolbox to the left, or amend the Category URL in the browser as follows:
	<pre>?action=pdfbook</pre>		<pre>?action=pdfbook</pre>
	'''Note:''' To produce a document of a single article, add the following to the URL of the article:		'''Note:''' To produce a document of a single article, add the following to the URL of the article:

Anw: 1 revision

2017-02-20T10:40:13Z

1 revision

← Older revision	Revision as of 12:40, 20 February 2017
(No difference)

Anw: Created page with "This page is intended to help with the automated production of PDF Books from the Assist pages. ==Creation of the book== *Create a title page, as the Document title plus the wor..."

2011-08-19T14:14:58Z

Created page with "This page is intended to help with the automated production of PDF Books from the Assist pages. ==Creation of the book== *Create a title page, as the Document title plus the wor..."

New page

This page is intended to help with the automated production of PDF Books from the Assist pages.

==Creation of the book==
*Create a title page, as the Document title plus the word "Title" on the end. The page can be created using the template provided. In addition, the footer must be configured on this page, utilising comments. For example:
<pre>
<nowiki>
{{Doc_Title|System=Calidus ''Vision''|Title=Vision Coding and Release|Reference=236343|Version=1.0|Date=9th May 2011}}



</nowiki>
</pre>
*Add this and all pages to be printed as part of the PDF book to a category of the same name, for example:
<pre>
<nowiki>
[[Category:Vision Coding and Release Doc|000]]
</nowiki>
</pre>
Note that the Category Sort value should be set to 000 for the title page. All other articles included in the document should have a sort value assigned to them to indicate the position in the document.
*If required, create an appendix page. This [[Template:Doc_Appendix|Template]] can be used as an example. This page should be named as the document title plus the word "Appendix" on the end. Note that the Category Sort should be set to 999.
*Create the Category page as in the following example:
<pre>
<nowiki>
=Vision Coding and Release=
This category encompasses pages that collate technical information of how the system is built and installed.
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook&notitle}} Download this selection of articles as a PDF book.]
</nowiki>
</pre>

==Production==
Click the link on the category entry created above, or amend the Category URL in the browser as follows:
<pre>?action=pdfbook</pre>
'''Note:''' To produce a document of a single article, add the following to the URL of the article:
<pre>?action=pdfbook&format=single</pre>

==Setup Requirements==