-
Notifications
You must be signed in to change notification settings - Fork 4
/
assembly.asm.xml
195 lines (195 loc) · 7.65 KB
/
assembly.asm.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE assembly
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<assembly version="5.2" xml:lang="en"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://docbook.org/ns/docbook">
<!-- resources section references all topic chunks used in the final article
-->
<!-- R E S O U R C E S -->
<!-- Glue files -->
<resources>
<resource xml:id="_glue-example" href="../glues/glue.xml">
<description>Glue example</description>
</resource>
<resource xml:id="_glue-more-info" href="../glues/glue-more-info.xml">
<description>Glue for more information</description>
</resource>
<resource xml:id="_glue-whats-next" href="../glues/glue-whats-next.xml">
<description>Glue what's next</description>
</resource>
</resources>
<!-- Concept files -->
<resources>
<resource xml:id="_concept-example" href="../concepts/concept.xml">
<description>Concept example</description>
</resource>
</resources>
<!-- Tasks -->
<resources>
<resource xml:id="_task-example" href="../tasks/task.xml">
<description>Task example</description>
</resource>
</resources>
<!-- References -->
<resources>
<resource xml:id="_reference-example" href="../references/reference.xml">
<description>Reference example</description>
</resource>
</resources>
<!-- Legal -->
<resources>
<resource href="../common/legal.xml" xml:id="_legal">
<description>Legal Notice</description>
</resource>
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
<description>GNU Free Documentation License</description>
</resource>
</resources>
<!-- S T R U C T U R E -->
<structure renderas="article" xml:id="article-example" xml:lang="en">
<merge>
<title>Your title, limit to 55 characters, if possible</title>
<subtitle>Subtitle if necessary</subtitle>
<!-- Create revision history to enable versioning: adjust the placeholder revhistory ID,
for each entry add the date of when the updated article will be published,
list most recent date/entry at the top -->
<!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
<revhistory xml:id="rh-USE-ROOT-ID">
<revision><date>YYYY-MM-DD</date>
<revdescription>
<!-- briefly sum up the major changes for the reader-->
<para>
Updated CONTENT, extended CONTENT, removed CONTENT
</para>
</revdescription>
</revision>
<revision><date>YYYY-MM-DD</date>
<revdescription>
<para>
Updated for the initial release of &productname; &productnumber;
</para>
</revdescription>
</revision>
</revhistory>
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
<!-- add author's e-mail -->
<meta name="maintainer" content="" its:translate="no"/>
<meta name="architecture">
<phrase>&x86-64;</phrase>
<phrase>&power;</phrase>
</meta>
<!-- enter one or more product names and version -->
<meta name="productname" its:translate="no">
<productname version="X.Y">&productname;</productname>
</meta>
<meta name="title" its:translate="yes">short title for SEO and social media, max. 55 chars</meta>
<meta name="description" its:translate="yes">short description, max. 150 chars</meta>
<meta name="social-descr" its:translate="yes">ultrashort description for social media, max 55 chars</meta>
<!-- suitable categories has to be identical with the category selected in the docserv config -->
<meta name="category" its:translate="no">
<phrase>Systems Management</phrase>
</meta>
<!-- Determines "filter by task" filter value -->
<!-- either add link to list or list of tasks-->
<meta name="task" its:translate="no">
<phrase>Configuration</phrase>
<phrase>Installation</phrase>
</meta>
<meta name="series">Products & Solutions</meta>
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Documentation</dm:component>
<dm:product><!--Bugzilla product string--></dm:product>
<!--
if the assembly applies to multiple products/productversions, use profiling:
<dm:product os="sles" condition="16.0">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:product os="sles" condition="16.1">SUSE Linux Enterprise Server 16.1</dm:product>
-->
<dm:assignee>[email protected]</dm:assignee>
<!-- replace with your BUGZILLA e-mail address, otherwise this does not work-->
</dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<variablelist>
<varlistentry>
<term>WHAT?</term>
<listitem>
<para>
Describe your topic in one sentence.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
State the reason why one should read this.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
What's the effort one has to put in?
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
What's the reader's take-away from this article?
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<itemizedlist>
<listitem>
<para>
List the requirements to accomplish the task(s) described below.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</abstract>
</merge>
<!-- pull in all the topic files you need -->
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_glue-example" renderas="section"/>
<!-- pull in a topic and switch the title -->
<module resourceref="_concept-example" renderas="section">
<merge>
<title>You are a very special concept now!</title>
</merge>
</module>
<module resourceref="_task-example" renderas="section"/>
<module resourceref="_reference-example" renderas="section"/>
<module resourceref="_glue-more-info" renderas="section"/>
<module resourceref="_glue-whats-next" renderas="section"/>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
<!-- TODO: second structure! -->
</assembly>