aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer/writing-style
diff options
context:
space:
mode:
authorWarren Block <wblock@FreeBSD.org>2014-03-08 00:15:43 +0000
committerWarren Block <wblock@FreeBSD.org>2014-03-08 00:15:43 +0000
commitb59cbd53648cbbe5b5ddd5a397482bd2513c8afb (patch)
tree695f4fd996bbce94eaf955d49c18728f157942d7 /en_US.ISO8859-1/books/fdp-primer/writing-style
parentb9186d33d4ce876b4be52b4903143900a70b7818 (diff)
downloaddoc-b59cbd53648cbbe5b5ddd5a397482bd2513c8afb.tar.gz
doc-b59cbd53648cbbe5b5ddd5a397482bd2513c8afb.zip
Add non-trivial indentation examples and an example of moving an element
to the next line to improve readability.
Notes
Notes: svn path=/head/; revision=44192
Diffstat (limited to 'en_US.ISO8859-1/books/fdp-primer/writing-style')
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
index b45d550227..0cbaafedb6 100644
--- a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
@@ -325,6 +325,33 @@
<tag class="endtag">sect1</tag>
<tag class="endtag">chapter</tag></programlisting>
+ <para>Tags containing long attributes follow the same
+ rules. Following the indentation rules in this case helps
+ editors and writers see which content is inside the
+ tags:</para>
+
+ <programlisting><tag class="starttag">para</tag>See the <tag class="starttag">link
+ linkend="gmirror-troubleshooting"</tag>Troubleshooting<tag class="endtag">link</tag>
+ section if there are problems booting. Powering down and
+ disconnecting the original <tag class="starttag">filename</tag>ada0<tag class="endtag">filename</tag> disk
+ will allow it to be kept as an offline backup.<tag class="endtag">para</tag>
+
+<tag class="starttag">para</tag>It is also possible to journal the boot disk of a &amp;os;
+ system. Refer to the article <tag class="starttag">link
+ xlink:href="&amp;url.articles.gjournal-desktop;"</tag>Implementing UFS
+ Journaling on a Desktop PC<tag class="endtag">link</tag> for detailed
+ instructions.<tag class="endtag">para</tag>></programlisting>
+
+ <para>When an element is too long to fit on the remainder of a
+ line without wrapping, moving the start tag to the next line
+ can make the source easier to read. In this example, the
+ <literal>systemitem</literal> element has been moved to the
+ next line to avoid wrapping and indenting:</para>
+
+ <programlisting><tag class="starttag">para</tag>With file flags, even
+ <tag class="starttag">systemitem class="username"</tag>root<tag class="endtag">systemitem</tag> can be
+ prevented from removing or altering files.<tag class="endtag">para</tag></programlisting>
+
<para>Configurations to help various text editors conform to
these guidelines can be found in
<xref linkend="editor-config"/>.</para>