Skip to content

Commit

Permalink
some typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
aabeatty committed Jul 25, 2024
1 parent fba82d1 commit 077d7c4
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 39 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.DS_Store

*.xpr
2 changes: 1 addition & 1 deletion en-us/course01-intro/topics/lc_reference.dita
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
title)</li>
<li>&lt;table> (a table)</li>
<li>&lt;fig> (a figure, including an optional title)</li>
<li>&lt;properties> (a list of properies)</li>
<li>&lt;properties> (a list of properties)</li>
<li>&lt;refsyn> (a syntax diagram)</li>
</ul></p>
<p>Video: <xref href="https://www.youtube.com/watch?v=l2y-MbYf2a4" format="html"
Expand Down
8 changes: 4 additions & 4 deletions en-us/course01-intro/topics/lc_topic.dita
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
<lcInstruction>
<p>A DITA topic is the basic unit of authoring and reuse. </p>
<p>In topic-based authoring, you create a number of individual topics, each of which
each addresses a single idea or answers a single question. These topics can then be
used and reused in any order, in a number of different documents. In DITA the topics
are organized in <i>maps</i>, which are much like a table of contents; the map
allows you to specify the order and the hierarchy of the topics. </p>
addresses a single idea or answers a single question. These topics can then be used
and reused in any order, in a number of different documents. In DITA the topics are
organized in <i>maps</i>, which are much like a table of contents; the map allows
you to specify the order and the hierarchy of the topics. </p>
<p>To make your topics reusable: </p>
<ul id="ul_kpb_fhh_rs">
<li>A topic should address a single idea or answer a single question. </li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
</prolog>
<learningContentbody>
<lcInstruction>
<p>Similar to the glossary entry topic, the glossary group topic must contain a
single &lt;glossgroup> root element with an id attribute that contains one
&lt;title> element and one or more &lt;glossterm> or &lt;glossgroup> elements, each
with an id attribute.</p>
<p>Similar to the glossary entry topic, the glossary group topic must contain a single
&lt;glossgroup> root element with an id attribute that contains one &lt;title>
element and one or more &lt;glossentry> or &lt;glossgroup> elements, each with an id
attribute.</p>
<note>
<p>This lesson covers basic use of the glossary group elements. For the full
specifications for each element, see the <xref
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<li>Do not use inline cross-references. In your version of the content, the
cross-reference target exists, but it might not be in the next map where your
content is reused. Instead, use DITA relationship tables to automatically
generate links to releated topics. </li>
generate links to related topics. </li>
</ul>
<p>To make your writing more generalized:</p>
<ul id="ul_jpy_vlc_kw">
Expand Down
54 changes: 25 additions & 29 deletions en-us/course07-reuse_advanced/topics/lc_conkeyrefs.dita
Original file line number Diff line number Diff line change
Expand Up @@ -20,52 +20,48 @@
an element in another file might look like this:
</p><pre>&lt;ul conref="domestic_duck_warehouse.dita#domestic_warehouse/nesting_materials">
&lt;li/>
&lt;/ul></pre><p>This
conref pulls a &lt;ul> element from a warehouse topic that contains reusable
elements relevant to domestic ducks. </p><p>If the topic containing this conref must
be reusable, a hard-coded filename will be a problem. To use the reusable topic in a
map that discusses wild ducks, the conref needs to point to a different warehouse
topic file (wild_duck_warehouse.dita). </p><p>Rather than hard code the path to a
file, you can use the conkeyref attribute to create a content reference that uses a
key, rather than a filename. </p><image keyref="i_conkeyref" id="image_j4p_ysl_zx"
base="2016/12"/><p>The first step in using a conkeyref is to create a DITA topic
(domestic_duck_warehouse.dita) that contains a reusable element (including an id
&lt;/ul></pre><p>This conref pulls a &lt;ul> element from a warehouse topic that
contains reusable elements relevant to domestic ducks. </p><p>If the topic
containing this conref must be reusable, a hard-coded filename will be a problem. To
use the reusable topic in a map that discusses wild ducks, the conref needs to point
to a different warehouse topic file (wild_duck_warehouse.dita). </p><p>Rather than
hard code the path to a file, you can use the conkeyref attribute to create a
content reference that uses a key, rather than a filename. </p><image
keyref="i_conkeyref" id="image_j4p_ysl_zx" base="2016/12"/><p>The first step in
using a conkeyref is to create a DITA topic (domestic_duck_warehouse.dita) that
contains a reusable element (including an id
attribute):</p><pre>&lt;ul id="nesting_materials">
&lt;li>Sawdust&lt;/li>
&lt;li>Wood shavings&lt;/li>
&lt;li>Sand&lt;/li>
...
&lt;/ul></pre><p>In
a map that references the topic that will use the conkeyref, define a key for the
warehouse file:
&lt;/ul></pre><p>In a map that references the topic that will use the conkeyref,
define a key for the warehouse file:
</p><pre>&lt;keydef keys="duck_warehouse" href="domestic_duck_warehouse.dita"/></pre><p>The
example at the beginning of this topic shows a &lt;ul> element with a conref.
Replace the conref attribute with a conkeyref attribute that contains the key, a
slash ('/'), and the id of the element to be pulled:
</p><pre>&lt;ul conkeyref="duck_warehouse/nesting_materials">
&lt;li/>
&lt;/ul></pre><note>When
using conkeyrefs you do not need to use the id of the topic that contains the
referenced element. </note><p>When the topic containing the conkeyref is processed,
the key duck_warehouse is replaced with the current key definition, which is
domestic_duck_warehouse.dita. </p><p>You can reuse the topic containing the
conkeyref in another DITA map, but you might need it to pull content from a file
that is specific to the new map. To do this, add a &lt;keydef> element to the new
map that defines the key so that it points to a different file. In this example, the
new map (that addresses wild ducks) defines the duck_warehouse key to point to
wild_duck_warehouse.dita:
&lt;/ul></pre><note>When using conkeyrefs you do not need to use the id of the topic
that contains the referenced element. </note><p>When the topic containing the
conkeyref is processed, the key duck_warehouse is replaced with the current key
definition, which is domestic_duck_warehouse.dita. </p><p>You can reuse the topic
containing the conkeyref in another DITA map, but you might need it to pull content
from a file that is specific to the new map. To do this, add a &lt;keydef> element
to the new map that defines the key so that it points to a different file. In this
example, the new map (that addresses wild ducks) defines the duck_warehouse key to
point to wild_duck_warehouse.dita:
</p><pre>&lt;keydef keys="duck_warehouse" href="wild_duck_warehouse.dita"/></pre><p>The
file wild_duck_warehouse.dita defines a different &lt;ul> element; however, it must
use the same id
attribute:</p><pre>&lt;ul id="nesting_materials">
use the same id attribute:</p><pre>&lt;ul id="nesting_materials">
&lt;li>Ferns&lt;/li>
&lt;li>Twigs&lt;/li>
&lt;li>Grass&lt;/li>
...
&lt;/ul></pre><p>When
this new key is used in the wile duck map, the unordered list of wild duck nesting
materials is used.</p><p>Finally, note that all the same rules that apply to conrefs
also apply to conkeyrefs: </p><ul id="ul_gzh_wmv_qx">
&lt;/ul></pre><p>When this new key is used in the wild duck map, the unordered list
of wild duck nesting materials is used.</p><p>Finally, note that all the same rules
that apply to conrefs also apply to conkeyrefs: </p><ul id="ul_gzh_wmv_qx">
<li>The referencing element must be the same type (element name) as the referenced
element. </li>
<li>The referencing element must be valid (for instance, a &lt;ul> element must
Expand Down

0 comments on commit 077d7c4

Please sign in to comment.