Expand contractions in the fdp-primer.
Also replace a few erroneous "it's" with the possessive "its".
This commit is contained in:
parent
0efd38263b
commit
96e9fe2ad3
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=11373
5 changed files with 31 additions and 31 deletions
|
@ -309,7 +309,7 @@ PRI_LANG?= en_US.ISO8859-1
|
||||||
|
|
||||||
<note>
|
<note>
|
||||||
<para><makevar>PRI_LANG</makevar> in no way affects what documents
|
<para><makevar>PRI_LANG</makevar> in no way affects what documents
|
||||||
can, or even will, be built. It's main use is creating links to
|
can, or even will, be built. Its main use is creating links to
|
||||||
commonly referenced documents into the FreeBSD documentation
|
commonly referenced documents into the FreeBSD documentation
|
||||||
install root.</para>
|
install root.</para>
|
||||||
</note>
|
</note>
|
||||||
|
@ -378,7 +378,7 @@ PRI_LANG?= en_US.ISO8859-1
|
||||||
|
|
||||||
<para>After that descriptive tuple, instructions on how to build
|
<para>After that descriptive tuple, instructions on how to build
|
||||||
the target may be given, if the conversion process between the
|
the target may be given, if the conversion process between the
|
||||||
target and it's dependencies are not previously defined, or if
|
target and its dependencies are not previously defined, or if
|
||||||
this particular conversion is not the same as the default
|
this particular conversion is not the same as the default
|
||||||
conversion method.</para>
|
conversion method.</para>
|
||||||
|
|
||||||
|
@ -399,7 +399,7 @@ PRI_LANG?= en_US.ISO8859-1
|
||||||
<para>What sets this macro apart from other targets? Basically,
|
<para>What sets this macro apart from other targets? Basically,
|
||||||
it is executed <emphasis>after</emphasis> the instructions
|
it is executed <emphasis>after</emphasis> the instructions
|
||||||
given in the build procedure it is listed as a dependency to,
|
given in the build procedure it is listed as a dependency to,
|
||||||
and it doesn't adjust <makevar>.TARGET</makevar>, which is the
|
and it does not adjust <makevar>.TARGET</makevar>, which is the
|
||||||
variable which contains the name of the target currently
|
variable which contains the name of the target currently
|
||||||
being built.</para>
|
being built.</para>
|
||||||
|
|
||||||
|
|
|
@ -331,7 +331,7 @@
|
||||||
To: freebsd-doc@FreeBSD.org
|
To: freebsd-doc@FreeBSD.org
|
||||||
Subject: New documentation available
|
Subject: New documentation available
|
||||||
|
|
||||||
There's a new copy of my primer for contributers to the FreeBSD
|
There is a new copy of my primer for contributors to the FreeBSD
|
||||||
Documentation Project available at
|
Documentation Project available at
|
||||||
|
|
||||||
<URL:http://people.FreeBSD.org/~nik/primer/index.html>
|
<URL:http://people.FreeBSD.org/~nik/primer/index.html>
|
||||||
|
@ -1128,7 +1128,7 @@
|
||||||
<para>In order to do this, use <sgmltag>itemizedlist</sgmltag>,
|
<para>In order to do this, use <sgmltag>itemizedlist</sgmltag>,
|
||||||
<sgmltag>orderedlist</sgmltag>, or
|
<sgmltag>orderedlist</sgmltag>, or
|
||||||
<sgmltag>procedure</sgmltag><footnote><para>There are other types of
|
<sgmltag>procedure</sgmltag><footnote><para>There are other types of
|
||||||
list element in DocBook, but we're not concerned with those at
|
list element in DocBook, but we are not concerned with those at
|
||||||
the moment.</para>
|
the moment.</para>
|
||||||
</footnote>
|
</footnote>
|
||||||
</para>
|
</para>
|
||||||
|
@ -1430,7 +1430,7 @@ main(void)
|
||||||
</informaltable>
|
</informaltable>
|
||||||
</example>
|
</example>
|
||||||
|
|
||||||
<para>If you don't want a border around the table the
|
<para>If you do not want a border around the table the
|
||||||
<literal>frame</literal> attribute can be added to the
|
<literal>frame</literal> attribute can be added to the
|
||||||
<sgmltag>informaltable</sgmltag> element with a value of
|
<sgmltag>informaltable</sgmltag> element with a value of
|
||||||
<literal>none</literal> (i.e., <literal><informaltable
|
<literal>none</literal> (i.e., <literal><informaltable
|
||||||
|
@ -2228,12 +2228,12 @@ This is the file called 'foo2'</screen>
|
||||||
<important>
|
<important>
|
||||||
<para>Image support in the documentation is currently extremely
|
<para>Image support in the documentation is currently extremely
|
||||||
experimental. I think the mechanisms described here are unlikely to
|
experimental. I think the mechanisms described here are unlikely to
|
||||||
change, but that's not guaranteed.</para>
|
change, but that is not guaranteed.</para>
|
||||||
|
|
||||||
<para>You will also need to install the
|
<para>You will also need to install the
|
||||||
<filename>graphics/ImageMagick</filename> port, which is used to
|
<filename>graphics/ImageMagick</filename> port, which is used to
|
||||||
convert between the different image formats. This is a big port,
|
convert between the different image formats. This is a big port,
|
||||||
and most of it is not required. However, while we're working on the
|
and most of it is not required. However, while we are working on the
|
||||||
<filename>Makefile</filename>s and other infrastructure it makes
|
<filename>Makefile</filename>s and other infrastructure it makes
|
||||||
things easier. This port is <emphasis>not</emphasis> in the
|
things easier. This port is <emphasis>not</emphasis> in the
|
||||||
<filename>textproc/docproj</filename> meta port, you must install it
|
<filename>textproc/docproj</filename> meta port, you must install it
|
||||||
|
@ -2241,7 +2241,7 @@ This is the file called 'foo2'</screen>
|
||||||
|
|
||||||
<para>The best example of what follows in practice is the
|
<para>The best example of what follows in practice is the
|
||||||
<filename>doc/en_US.ISO8859-1/articles/vm-design/</filename> document.
|
<filename>doc/en_US.ISO8859-1/articles/vm-design/</filename> document.
|
||||||
If you're unsure of the description that follows, take a look at the
|
If you are unsure of the description that follows, take a look at the
|
||||||
files in that directory to see how everything hangs together.
|
files in that directory to see how everything hangs together.
|
||||||
Experiment with creating different formatted versions of the
|
Experiment with creating different formatted versions of the
|
||||||
document to see how the image markup appears in the formatted
|
document to see how the image markup appears in the formatted
|
||||||
|
@ -2512,7 +2512,7 @@ IMAGES= chapter1/fig1.png
|
||||||
<title><sgmltag>anchor</sgmltag></title>
|
<title><sgmltag>anchor</sgmltag></title>
|
||||||
|
|
||||||
<programlisting><![ CDATA [<para>This paragraph has an embedded
|
<programlisting><![ CDATA [<para>This paragraph has an embedded
|
||||||
<anchor id="para1">link target in it. It won't show up in
|
<anchor id="para1">link target in it. It will not show up in
|
||||||
the document.</para>]]></programlisting>
|
the document.</para>]]></programlisting>
|
||||||
</example>
|
</example>
|
||||||
|
|
||||||
|
|
|
@ -315,7 +315,7 @@
|
||||||
<example>
|
<example>
|
||||||
<title>Single quotes around attributes</title>
|
<title>Single quotes around attributes</title>
|
||||||
|
|
||||||
<programlisting><![ CDATA [<p align='right'>I'm on the right!</p>]]></programlisting>
|
<programlisting><![ CDATA [<p align='right'>I am on the right!</p>]]></programlisting>
|
||||||
</example>
|
</example>
|
||||||
|
|
||||||
<para>Sometimes you do not need to use quotes around attribute values at
|
<para>Sometimes you do not need to use quotes around attribute values at
|
||||||
|
@ -592,8 +592,8 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
||||||
</title>
|
</title>
|
||||||
|
|
||||||
<note>
|
<note>
|
||||||
<para>You don't need to know this, but it's useful background, and
|
<para>You do not need to know this, but it is useful background, and
|
||||||
might help you debug problems when your SGML processor can't locate
|
might help you debug problems when your SGML processor can not locate
|
||||||
the DTD you are using.</para>
|
the DTD you are using.</para>
|
||||||
</note>
|
</note>
|
||||||
|
|
||||||
|
@ -633,7 +633,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
||||||
to assign registered names. The ISO council delegated this to
|
to assign registered names. The ISO council delegated this to
|
||||||
the American National Standards Institute (ANSI).</para>
|
the American National Standards Institute (ANSI).</para>
|
||||||
|
|
||||||
<para>Because the FreeBSD Project hasn't been registered the
|
<para>Because the FreeBSD Project has not been registered the
|
||||||
owner string is <literal>-//FreeBSD</literal>. And as you can
|
owner string is <literal>-//FreeBSD</literal>. And as you can
|
||||||
see, the W3C are not a registered owner either.</para>
|
see, the W3C are not a registered owner either.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -756,7 +756,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
||||||
typically (but not always) means the DTD will be provided as a
|
typically (but not always) means the DTD will be provided as a
|
||||||
filename.</para>
|
filename.</para>
|
||||||
|
|
||||||
<para>Using FPIs is preferred for reasons of portability. You don't
|
<para>Using FPIs is preferred for reasons of portability. You do not
|
||||||
want to have to ship a copy of the DTD around with your document, and
|
want to have to ship a copy of the DTD around with your document, and
|
||||||
if you used the <literal>SYSTEM</literal> identifier then everyone
|
if you used the <literal>SYSTEM</literal> identifier then everyone
|
||||||
would need to keep their DTDs in the same place.</para>
|
would need to keep their DTDs in the same place.</para>
|
||||||
|
@ -1038,7 +1038,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
||||||
(you may need to copy it to <filename>example.html</filename>
|
(you may need to copy it to <filename>example.html</filename>
|
||||||
before your browser recognises it as an HTML document).</para>
|
before your browser recognises it as an HTML document).</para>
|
||||||
|
|
||||||
<para>Unless your browser is very advanced, you won't see the entity
|
<para>Unless your browser is very advanced, you will not see the entity
|
||||||
reference <literal>&version;</literal> replaced with the
|
reference <literal>&version;</literal> replaced with the
|
||||||
version number. Most web browsers have very simplistic parsers
|
version number. Most web browsers have very simplistic parsers
|
||||||
which do not handle proper SGML<footnote>
|
which do not handle proper SGML<footnote>
|
||||||
|
@ -1394,7 +1394,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
||||||
<programlisting>
|
<programlisting>
|
||||||
<![ CDATA [ <![ CDATA [
|
<![ CDATA [ <![ CDATA [
|
||||||
<p>This is a sample that shows you some of the elements within
|
<p>This is a sample that shows you some of the elements within
|
||||||
HTML. Since the angle brackets are used so many times, it's
|
HTML. Since the angle brackets are used so many times, it is
|
||||||
simpler to say the whole example is a CDATA marked section
|
simpler to say the whole example is a CDATA marked section
|
||||||
than to use the entity names for the left and right angle
|
than to use the entity names for the left and right angle
|
||||||
brackets throughout.</p>
|
brackets throughout.</p>
|
||||||
|
@ -1436,7 +1436,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
||||||
]]></programlisting>
|
]]></programlisting>
|
||||||
</example>
|
</example>
|
||||||
|
|
||||||
<para>By itself, this isn't too useful. If you wanted to remove text
|
<para>By itself, this is not too useful. If you wanted to remove text
|
||||||
from your document you could cut it out, or wrap it in
|
from your document you could cut it out, or wrap it in
|
||||||
comments.</para>
|
comments.</para>
|
||||||
|
|
||||||
|
@ -1448,10 +1448,10 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
||||||
|
|
||||||
<para>For example, suppose that you produced a hard-copy version of
|
<para>For example, suppose that you produced a hard-copy version of
|
||||||
some documentation and an electronic version. In the electronic
|
some documentation and an electronic version. In the electronic
|
||||||
version you wanted to include some extra content that wasn't to
|
version you wanted to include some extra content that was not to
|
||||||
appear in the hard-copy.</para>
|
appear in the hard-copy.</para>
|
||||||
|
|
||||||
<para>Create a parameter entity, and set it's value to
|
<para>Create a parameter entity, and set its value to
|
||||||
<literal>INCLUDE</literal>. Write your document, using marked
|
<literal>INCLUDE</literal>. Write your document, using marked
|
||||||
sections to delimit content that should only appear in the
|
sections to delimit content that should only appear in the
|
||||||
electronic version. In these marked sections use the parameter
|
electronic version. In these marked sections use the parameter
|
||||||
|
|
|
@ -158,7 +158,7 @@
|
||||||
versions of the files that make up the documentation.</para>
|
versions of the files that make up the documentation.</para>
|
||||||
|
|
||||||
<para>[XXX To Do -- write a tutorial that shows how to use CVSup to
|
<para>[XXX To Do -- write a tutorial that shows how to use CVSup to
|
||||||
get just the documentation, check it out, and see what's changed
|
get just the documentation, check it out, and see what has changed
|
||||||
between two arbitrary revisions]</para>
|
between two arbitrary revisions]</para>
|
||||||
</answer>
|
</answer>
|
||||||
</qandaentry>
|
</qandaentry>
|
||||||
|
@ -174,14 +174,14 @@
|
||||||
url="../../../../docproj/translations.html">Documentation
|
url="../../../../docproj/translations.html">Documentation
|
||||||
Project translations page</ulink> lists the translation efforts
|
Project translations page</ulink> lists the translation efforts
|
||||||
that are currently known about. If others are already working
|
that are currently known about. If others are already working
|
||||||
on translating documentation to your language, please don't
|
on translating documentation to your language, please do not
|
||||||
duplicate their efforts. Instead, contact them to see how you can
|
duplicate their efforts. Instead, contact them to see how you can
|
||||||
help.</para>
|
help.</para>
|
||||||
|
|
||||||
<para>If no one is listed on that page as translating for your
|
<para>If no one is listed on that page as translating for your
|
||||||
language, then send a message to
|
language, then send a message to
|
||||||
<email>freebsd-doc@FreeBSD.org</email> in case someone else is
|
<email>freebsd-doc@FreeBSD.org</email> in case someone else is
|
||||||
thinking of doing a translation, but hasn't announced it yet.</para>
|
thinking of doing a translation, but has not announced it yet.</para>
|
||||||
</answer>
|
</answer>
|
||||||
</qandaentry>
|
</qandaentry>
|
||||||
|
|
||||||
|
@ -195,7 +195,7 @@
|
||||||
<replaceable>your-language-here</replaceable> Documentation
|
<replaceable>your-language-here</replaceable> Documentation
|
||||||
Translation Project</quote>. Welcome aboard.</para>
|
Translation Project</quote>. Welcome aboard.</para>
|
||||||
|
|
||||||
<para>First, decide whether or not you've got the time to spare. Since
|
<para>First, decide whether or not you have got the time to spare. Since
|
||||||
you are the only person working on your language at the moment it is
|
you are the only person working on your language at the moment it is
|
||||||
going to be your responsibility to publicise your work and
|
going to be your responsibility to publicise your work and
|
||||||
coordinate any volunteers that might want to help you.</para>
|
coordinate any volunteers that might want to help you.</para>
|
||||||
|
@ -221,7 +221,7 @@
|
||||||
|
|
||||||
<qandaentry>
|
<qandaentry>
|
||||||
<question>
|
<question>
|
||||||
<para>I've translated some documentation, where do I send it?</para>
|
<para>I have translated some documentation, where do I send it?</para>
|
||||||
</question>
|
</question>
|
||||||
|
|
||||||
<answer>
|
<answer>
|
||||||
|
@ -239,12 +239,12 @@
|
||||||
|
|
||||||
<qandaentry>
|
<qandaentry>
|
||||||
<question>
|
<question>
|
||||||
<para>I'm the only person working on translating to this language, how
|
<para>I am the only person working on translating to this language, how
|
||||||
do I submit my translation?</para>
|
do I submit my translation?</para>
|
||||||
|
|
||||||
<para>or</para>
|
<para>or</para>
|
||||||
|
|
||||||
<para>We're a translation team, and want to submit documentation that
|
<para>We are a translation team, and want to submit documentation that
|
||||||
our members have translated for us?</para>
|
our members have translated for us?</para>
|
||||||
</question>
|
</question>
|
||||||
|
|
||||||
|
@ -342,7 +342,7 @@
|
||||||
Korean, and want to include a section about retailers in Korea in
|
Korean, and want to include a section about retailers in Korea in
|
||||||
your Handbook.</para>
|
your Handbook.</para>
|
||||||
|
|
||||||
<para>There's no real reason why that information should not be in the
|
<para>There is no real reason why that information should not be in the
|
||||||
English (or German, or Spanish, or Japanese, or …) versions
|
English (or German, or Spanish, or Japanese, or …) versions
|
||||||
as well. It is feasible that an English speaker in Korea might try
|
as well. It is feasible that an English speaker in Korea might try
|
||||||
and pick up a copy of FreeBSD whilst over there. It also helps
|
and pick up a copy of FreeBSD whilst over there. It also helps
|
||||||
|
|
|
@ -147,7 +147,7 @@
|
||||||
a period denotes a new sentence, this is not the case, especially
|
a period denotes a new sentence, this is not the case, especially
|
||||||
in name usage. <quote>Jordan K. Hubbard</quote> is a good
|
in name usage. <quote>Jordan K. Hubbard</quote> is a good
|
||||||
example; it has a capital <literal>H</literal> following a
|
example; it has a capital <literal>H</literal> following a
|
||||||
period and a space, and there certainly isn't a new sentence
|
period and a space, and there certainly is not a new sentence
|
||||||
there.</para>
|
there.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
@ -269,12 +269,12 @@ V
|
||||||
<title>Separating tags</title>
|
<title>Separating tags</title>
|
||||||
|
|
||||||
<para>Tags like <sgmltag>itemizedlist</sgmltag> which will
|
<para>Tags like <sgmltag>itemizedlist</sgmltag> which will
|
||||||
always have further tags inside them, and in fact don't take
|
always have further tags inside them, and in fact do not take
|
||||||
character data themselves, are always on a line by
|
character data themselves, are always on a line by
|
||||||
themselves.</para>
|
themselves.</para>
|
||||||
|
|
||||||
<para>Tags like <sgmltag>para</sgmltag> and
|
<para>Tags like <sgmltag>para</sgmltag> and
|
||||||
<sgmltag>term</sgmltag> don't need other tags to contain
|
<sgmltag>term</sgmltag> do not need other tags to contain
|
||||||
normal character data, and their contents begin immediately
|
normal character data, and their contents begin immediately
|
||||||
after the tag, <emphasis>on the same line</emphasis>.</para>
|
after the tag, <emphasis>on the same line</emphasis>.</para>
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue