Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated common DITA topics and maps #912

Open
wants to merge 15 commits into
base: DITA-2.0
Choose a base branch
from
Open

Updated common DITA topics and maps #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
1e80e36
Update basic-concepts.dita
rothwelc Dec 5, 2023
8e78390
Update definition-of-ditamaps.dita
rothwelc Dec 5, 2023
a48ba59
Update ditamap-attributes.dita
rothwelc Dec 5, 2023
c82e112
Update introduction-to-dita.dita
rothwelc Dec 5, 2023
235a7fb
Update maps.ditamap
rothwelc Dec 5, 2023
a56ef2f
Update single-sourcing.dita
rothwelc Dec 5, 2023
f74c227
Update topicbenefits.dita
rothwelc Dec 5, 2023
0e6486c
Update topiccontent.dita
rothwelc Dec 5, 2023
65ba140
Update topicdefined.dita
rothwelc Dec 5, 2023
907c3bf
Update topics.ditamap
rothwelc Dec 5, 2023
9e3cc99
Update topicstructure.dita
rothwelc Dec 5, 2023
0f0d1fe
Update ditamap-processing.ditamap
rothwelc Dec 5, 2023
446cbd7
Add files via upload
rothwelc Dec 5, 2023
164a406
Add files via upload
rothwelc Dec 5, 2023
181792c
Update conref-file.dita
rothwelc Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion specification/archSpec/base/definition-of-ditamaps.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,3 @@ they can be used and reused in multiple different contexts.</p>
are resolved.</p>
</conbody>
</concept>

7 changes: 4 additions & 3 deletions specification/archSpec/base/ditamap-attributes.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,9 @@
<dd/>
</dlentry>
</dl>
<p>For more information, see <xref href="example-cascade-attribute.dita" format="dita"
/>.</p>
<p>For more information, see <xref
href="example-how-cascade-att-functions.dita" format="dita"
/>.</p>
</dd>
</dlentry>
<dlentry>
Expand Down Expand Up @@ -237,4 +238,4 @@
incorporated into both map and topic structural types. </p>
</section>
</conbody>
</concept>
</concept>
5 changes: 0 additions & 5 deletions specification/archSpec/base/ditamap-processing.ditamap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@
<topicref href="impose-topicref-role.dita">
<topicref href="example-impose-topicref-roles.dita"/>
</topicref>
<topicref href="example-ditamaps.dita">
<topicref href="example-simple-map-w-submap.dita"/>
<topicref href="example-simple-map-w-reltable.dita"/>
<topicref href="example-collection-type-and-linking-atts.dita"/>
</topicref>
</topicref>
<mapref href="subject-scheme-maps.ditamap"/>
<mapref href="cascading-metadata.ditamap"/>
Expand Down
33 changes: 33 additions & 0 deletions specification/archSpec/base/example-how-cascade-att-functions.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept xml:lang="en-us" id="concept_efq_qrv_vr">
<title>Example: How the <xmlatt>cascade</xmlatt> attribute functions</title>
<shortdesc>The following example illustrates how the <xmlatt>cascade</xmlatt> attribute can be used
to fine tune how the values for the <xmlatt>platform</xmlatt> attribute apply to topics referenced
in a DITA map.</shortdesc>
<conbody>
<p>Here a DITA map contains a collection of topics that apply to Windows, Linux, and Macintosh OS;
it also contains a topic that is only applicable to users running the application on Linux. </p>
<codeblock>&lt;map product="PuffinTracker" platform="win linux mac" <b>cascade="nomerge"</b>>
&lt;title>Puffin Tracking Software&lt;/title>
&lt;topicref href="introduction.dita"/>
&lt;topicref href="setting-up-the-product.dita"/>
&lt;topicref href="linux-instructions.dita" platform="linux"/>
&lt;/map></codeblock>
<p>The values of the <xmlatt>platform</xmlatt> attribute set at the map level cascade throughout
the map and apply to the <filepath>introduction.dita</filepath> and
<filepath>setting-up-the-product.dita</filepath> topics. However, since the value of the
<xmlatt>cascade</xmlatt> attribute is set to <keyword>nomerge</keyword>, the value of the
<xmlatt>platform</xmlatt> attribute for the <filepath>linux-instructions.dita</filepath> topic
does not merge with the values that cascade from above in the DITA map. The effective value of
the <xmlatt>platform</xmlatt> attribute for <filepath>linux-instructions.dita</filepath> is
<keyword>linux</keyword>.</p>
<p>The same results are produced by the following mark-up:</p>
<codeblock>&lt;map product="PuffinTracker" platform="win linux mac">
&lt;title>Puffin Tracking Software&lt;/title>
&lt;topicref href="introduction.dita"/>
&lt;topicref href="setting-up-the-product.dita"/>
&lt;topicref href="linux-instructions.dita" platform="linux" cascade="nomerge"/>
&lt;/map></codeblock>
</conbody>
</concept>
24 changes: 24 additions & 0 deletions specification/archSpec/base/generictopics.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"concept.dtd">
<concept id="generictopics" xml:lang="en-us">
<title>Generic topics</title>
<shortdesc>The element type <xmlelement>topic</xmlelement> is the base topic type from which all
other topic types are specialized. All topics have the same basic structure. </shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm>topics<indexterm>generic topic type</indexterm></indexterm>
</keywords>
</metadata>
</prolog>
<conbody>
<p>For authors, typed content is preferred to support consistency in writing and presentation to
readers. The generic topic type is best used only if authors are not trained in information
typing or when a specialized topic type is inappropriate. The OASIS DITA standard provides
several specialized topic types, including concept, task, and reference that are critical for
technical content development. </p>
<p>For those pursuing specialization, specialize new topic types from appropriate ancestors to
meet authoring and output requirements. </p>
</conbody>
</concept>
6 changes: 6 additions & 0 deletions specification/archSpec/base/maps.ditamap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,11 @@
<topicref href="definition-of-ditamaps.dita"/>
<topicref href="purpose-of-ditamaps.dita"/>
<topicref href="ditamap-attributes.dita"/>
<topicref href="example-ditamaps.dita">
<topicref href="example-simple-map-w-submap.dita"/>
<topicref href="example-simple-map-w-reltable.dita"/>
<topicref href="example-collection-type-and-linking-atts.dita"/>
<topicref href="example-how-cascade-att-functions.dita"/>
</topicref>
</topicref>
</map>
1 change: 0 additions & 1 deletion specification/archSpec/base/single-sourcing.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,3 @@
renderings.</p>
</conbody>
</concept>

1 change: 1 addition & 0 deletions specification/archSpec/base/topics.ditamap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<topicref href="topicbenefits.dita"/>
<topicref href="topicorientation.dita"/>
<topicref href="information-typing.dita"/>
<topicref href="generictopics.dita"/>
<topicref href="topicstructure.dita"/>
<topicref href="topiccontent.dita"/>
</topicref>
Expand Down
15 changes: 8 additions & 7 deletions specification/common/conref-file.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,13 +282,14 @@ to alert more birds to the presence of your bird feeder.&lt;/shortdesc&gt;
<ph id="groupdefn">The attribute can also include groups of values specified using the same syntax as generalized attributes within <xmlatt>props</xmlatt>; see <xref href="../archSpec/base/generalization-attributes.dita"/> for details on grouping syntax.</ph>
<ph id="dateformat">The date is specified using the ISO 8601 format: <varname>YYYY</varname>-<varname>MM</varname>-<varname>DD</varname>, where <varname>YYYY</varname> is the year, <varname>MM</varname> is the month (01 to 12), and <varname>DD</varname> is the day (01-31).</ph></lines>
</section>
<section id="section-9"><title>Reused error conditions</title><ph id="index-sort-as"
outputclass="errorcondition">When located within the <xmlelement>indexterm</xmlelement>
element, the <xmlelement>sort-as</xmlelement> element is equivalent to
<xmlelement>index-sort-as</xmlelement>. It is an error for an
<xmlelement>indexterm</xmlelement> element to directly contain both
<xmlelement>sort-as</xmlelement> and <xmlelement>index-sort-as</xmlelement>
elements.</ph></section>
<section id="section-9"><title>Reused error conditions</title><ph id="index-sort-as">When located
within the <xmlelement>indexterm</xmlelement> element, the
<xmlelement>sort-as</xmlelement> element is equivalent to
<xmlelement>index-sort-as</xmlelement>. It is an error for
an <xmlelement>indexterm</xmlelement> element to directly contain
both <xmlelement>sort-as</xmlelement> and
<xmlelement>index-sort-as</xmlelement>
elements.</ph></section>
<section id="section-10">
<title>Constraints material</title>
<ul id="dtd-domains-contribution">
Expand Down