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