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