add revision information
[sitka/doc/style.git] / style / style-template.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="style-template" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
3     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
4 \r
5     <info>\r
6         <revhistory>\r
7             <revision>\r
8                 <revnumber>1</revnumber>\r
9                 <date>2009-10-13</date>\r
10                 <authorinitials>JB</authorinitials>\r
11                 <revremark>Revised to include example of revhistory element</revremark>\r
12             </revision>\r
13                         <revision>\r
14                 <revnumber>2</revnumber>\r
15                 <date>20016-07-27</date>\r
16                 <authorinitials>CB</authorinitials>\r
17                 <revremark>Revised to include image capture effects & instructions to open a link in new tab</revremark>\r
18             </revision>\r
19         </revhistory>\r
20 \r
21         <title>Sitka Documentation Template</title>\r
22     </info>\r
23 \r
24     <para>The source xml file for this template page is in the Sitka DocBook directory at\r
25             <emphasis>www/Sitka/draft/template.xml</emphasis>. To use it as a template for new Sitka\r
26         documenation follow the steps below.</para>\r
27 \r
28     <section>\r
29         <info>\r
30             <title>Open <emphasis>template.xml</emphasis></title>\r
31         </info>\r
32 \r
33         <para>Optional intro paragraph for section</para>\r
34 \r
35         <procedure>\r
36             <step>\r
37                 <para>Open oXygen XML Author or Editor</para>\r
38             </step>\r
39 \r
40             <step>\r
41                 <para>Right-click <guilabel>newProject.xpr</guilabel> (in the left column) and\r
42                     choose <guimenuitem>Import Remote Folders</guimenuitem></para>\r
43             </step>\r
44 \r
45             <step>\r
46                 <para>Enter DocBook server url, username, and password for SFTP connection (not\r
47                     publicly available), then click <guibutton>Browse</guibutton></para>\r
48             </step>\r
49 \r
50             <step>\r
51                 <informalfigure>\r
52                     <para>Navigate to /home/jbuhler/www/Sitka/draft. Select this folder, then click\r
53                             <guibutton>OK</guibutton> (ed note: this is also an example of how to\r
54                         keep step text and image together, displaying an image that's less than\r
55                         900px wide)</para>\r
56                     <para>\r
57                         <mediaobject>\r
58                             <alt>screenshot of staff client</alt>\r
59                             <imageobject>\r
60                                 <imagedata scalefit="0" fileref="media/style-template-1.png"/>\r
61                             </imageobject>\r
62                         </mediaobject>\r
63                     </para>\r
64                 </informalfigure>\r
65             </step>\r
66 \r
67             <step>\r
68                 <para>In oXygen, double-click on <guilabel>newProject.xpr*</guilabel>. Navigate to\r
69                         <emphasis>draft/template.xml</emphasis>, then double-click it to open</para>\r
70             </step>\r
71 \r
72             <step>\r
73                 <informalfigure>\r
74                     <para><emphasis>template.xml</emphasis> will open in oXygen (ed note: this is\r
75                         also an example of how to keep step text and image together, displaying an\r
76                         image that's wider than 900px)</para>\r
77                     <para>\r
78                         <mediaobject>\r
79                             <alt>screenshot of staff client</alt>\r
80                             <imageobject>\r
81                                 <imagedata width="100%" scalefit="1"\r
82                                     fileref="media/style-template-2.png"/>\r
83                             </imageobject>\r
84                         </mediaobject>\r
85                     </para>\r
86                 </informalfigure>\r
87             </step>\r
88         </procedure>\r
89 \r
90     </section>\r
91 \r
92     <section>\r
93         <info>\r
94             <title>Save as new xml file</title>\r
95         </info>\r
96 \r
97         <para>Optional intro paragraph for section</para>\r
98 \r
99         <procedure>\r
100             <step>\r
101                 <para>Make the following changes to <emphasis>template.xml</emphasis></para>\r
102                 <itemizedlist>\r
103                     <listitem>\r
104                         <para>Change the chapter xml:id from <emphasis>style-template</emphasis> to\r
105                             a new unique value</para>\r
106                     </listitem>\r
107                     <listitem>\r
108                         <para>Change the title from <emphasis>Sitka Documentation\r
109                                 Template</emphasis></para>\r
110                     </listitem>\r
111                 </itemizedlist>\r
112             </step>\r
113 \r
114             <step>\r
115                 <para>Go to <menuchoice>\r
116                         <guimenu>File</guimenu>\r
117                         <guimenuitem>Save to URL...</guimenuitem>\r
118                     </menuchoice> and save to desired Sitka docs directory (using a newly assigned\r
119                     name, not <emphasis>template.xml</emphasis>)</para>\r
120             </step>\r
121 \r
122             <step>\r
123                 <para>While customizing the file, use <keycombo>\r
124                         <keycap>Ctrl</keycap>\r
125                         <keycap>S</keycap>\r
126                     </keycombo> to save changes</para>\r
127             </step>\r
128 \r
129             <step>\r
130                 <para>Open <emphasis>root.xml</emphasis> and add a new\r
131                         <emphasis>xi:includes</emphasis> line pointing to the newly created file,\r
132                     adding it to the larger Sitka doc set; save changes</para>\r
133             </step>\r
134         </procedure>\r
135 \r
136         <para/>\r
137         <tip>\r
138             <para>Use <keycombo>\r
139                     <keycap>Ctrl</keycap>\r
140                     <keycap>Shift</keycap>\r
141                     <keycap>P</keycap>\r
142                 </keycombo> to automatically indent and space an xml file in oXygen, making it\r
143                 easier to read and work with</para>\r
144         </tip>\r
145 \r
146     </section>\r
147 \r
148 </chapter>\r