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