LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

Verified the rpmupgrade file with these conventions and wound up 

changing the conventions more than the rpmupgrade file.

Removed the requirement of an appendix, Linux license examples,
links to local documents. Cleaned up the wording of how to format
a command prompt. Other small rewordings.
This commit is contained in:
nevets72 2002-03-08 15:44:51 +00:00
parent 74dce28aa6
commit dafeea842b
1 changed files with 17 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
LDP/howto/docbook/rpmupgrade.sgml/conventions.xml
View File

@ -9,6 +9,10 @@
<itemizedlist> <itemizedlist>
<listitem>
<para>Use Docbook XML V4.1.2</para>
</listitem>
<listitem> <listitem>
<para>Single space after a period.</para></listitem> <para>Single space after a period.</para></listitem>
@ -22,7 +26,7 @@
<listitem> <listitem>
<para>All sect1 elements have the id attribute filled in <para>All sect1 elements have the id attribute filled in
with the filename of the HTML verion of the HOWTO.</para></listitem> with the filename of the HTML version of the HOWTO.</para></listitem>
<listitem> <listitem>
<para>Whenever suggesting that the reader try a command, <para>Whenever suggesting that the reader try a command,
@ -50,37 +54,26 @@
keysym, shortcut, accel)</para></listitem> keysym, shortcut, accel)</para></listitem>
<listitem> <listitem>
<para>Use a "$" as the user's shell prompt and "#" as the <para>Precede commands with a prompt that mimicks the real
root shell prompt. The prompt should identify the prompt. Use a "$" as the user's shell prompt and "#" as the
shell or application that presents the prompt. root shell prompt. Also name the application that
Tag them with prompt.</para></listitem> generates the prompt. Tag them with
&#60;prompt&#62;.</para>
</listitem>
<listitem> <listitem>
<para>URLs to documents go at the end of the <para>Biblios will have a URL to the document. Put
article.</para></listitem>
<listitem>
<para>Biblios will have two URLs to the document, one
internet (http:, ftp:) and one locate (file:). Put
it inside of releaseinfo.</para></listitem> it inside of releaseinfo.</para></listitem>
<listitem> <listitem>
<para>Standard licensing text will be put into an <para>Standard licensing text will be put into an
appendix.</para></listitem> sect1.</para></listitem>
<listitem> <listitem>
<para>Appendix information for the various, standard <para>Use these terms: Gbyte, Mbyte, Kbyte, byte.</para></listitem>
licences (GPL, LGPL, Artistic, BSD, etc.).</para></listitem>
<listitem>
<para>Use Gbyte, Mbyte, Kbyte, byte.</para></listitem>
<listitem> <listitem>
<para>dependant, not dependent</para></listitem> <para>Use this spelling : dependant, not dependent</para></listitem>
<listitem>
<para>put a warning whereever a file is getting erased or overwritten.</para>
</listitem>
<listitem> <listitem>
<para>make a note to merge/remove the .rpmsave files.</para> <para>make a note to merge/remove the .rpmsave files.</para>
@ -110,12 +103,7 @@ date, publish date, version, ulink.</para>
<para>Make sure that punctionation and words which follow <para>Make sure that punctionation and words which follow
a tag don't get extra spaces added by tidy, where they a tag don't get extra spaces added by tidy, where they
don't belong. This is true of tags before periods and don't belong. This is true of tags before periods and
other punctuation and ...</para> all the other punctuation</para>
</listitem>
<listitem>
<para>The '&#62;' character remains in the HTML for xref
tags. They should be removed.</para>
</listitem> </listitem>
<listitem> <listitem>
@ -145,7 +133,7 @@ by tidy.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>The bibliography has double periods after each <para>Make sure that the bibliography has double periods after each
entry.</para> entry.</para>
</listitem> </listitem>