From 9e1d1c15667b6952a9a06f0a67121e3376bb4ccd Mon Sep 17 00:00:00 2001 From: Yaroslav Tykhiy Date: Mon, 12 Sep 2005 16:47:36 +0000 Subject: Except for some rare cases, always use punctuation to finish a sentence at the end of a paragraph so that the readers don't think that some text is missing. Consistently use colons to finish sentences introductory to examples. --- .../books/fdp-primer/doc-build/chapter.sgml | 4 +- .../books/fdp-primer/sgml-markup/chapter.sgml | 28 +++++++------- .../books/fdp-primer/sgml-primer/chapter.sgml | 44 +++++++++++----------- .../books/fdp-primer/structure/chapter.sgml | 6 +-- .../books/fdp-primer/the-website/chapter.sgml | 4 +- .../books/fdp-primer/translations/chapter.sgml | 8 ++-- .../books/fdp-primer/writing-style/chapter.sgml | 6 +-- 7 files changed, 50 insertions(+), 50 deletions(-) (limited to 'en_US.ISO8859-1') diff --git a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml index b171aeddb2..ca0beb0f5e 100644 --- a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml @@ -422,10 +422,10 @@ PRI_LANG?= en_US.ISO8859-1 install and package both go down the directory tree calling the real versions of themselves - in the subdirectories. + in the subdirectories (realinstall and realpackage - respectively) + respectively). diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml index 08ef201c3f..cafc9ef65f 100644 --- a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml @@ -322,7 +322,7 @@ <sgmltag>pre</sgmltag> You could use pre to mark up an e-mail - message; + message: From: nik@FreeBSD.org To: freebsd-doc@FreeBSD.org @@ -654,7 +654,7 @@ Linking to a named part of the same document Assume that the para1 example resides in - this document + this document: More information can be found in the first paragraph of this @@ -727,7 +727,7 @@ In compliance with the DocBook guidelines for writing FPIs for DocBook customizations, the FPI for the FreeBSD extended DocBook DTD - is; + is: PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" @@ -1039,7 +1039,7 @@ Use: - A small excerpt from the US Constitution; + A small excerpt from the US Constitution:
Preamble to the Constitution of the United States @@ -1086,7 +1086,7 @@ use sidebar. The circumstances in which to choose one of these elements over - another is unclear. The DocBook documentation suggests; + another is unclear. The DocBook documentation suggests: @@ -1274,7 +1274,7 @@ main(void) Appearance: When you have finished, your program should look like - this; + this: #include <stdio.h> @@ -1306,7 +1306,7 @@ main(void) calloutlist When you have finished, your program should look like - this; + this: #include <stdio.h> @@ -1335,7 +1335,7 @@ main(void) Appearance: When you have finished, your program should look like - this; + this: #include <stdio.h> @@ -2477,7 +2477,7 @@ IMAGES+= fig3.png For example, if you have chapter1/fig1.png, then chapter1/chapter.sgml should - contain + contain: <mediaobject> <imageobject> @@ -2491,11 +2491,11 @@ IMAGES+= fig3.png The directory name must be included in the - fileref attribute + fileref attribute. - The Makefile must contain + The Makefile must contain: … IMAGES= chapter1/fig1.png @@ -2586,7 +2586,7 @@ IMAGES= chapter1/fig1.png Using <sgmltag>xref</sgmltag> Assume that this fragment appears somewhere in a document that - includes the id example; + includes the id example: More information can be found in . @@ -2596,7 +2596,7 @@ IMAGES= chapter1/fig1.png The text of the link will be generated automatically, and will look like (emphasized text indicates the text - that will be the link); + that will be the link):
More information can be found in Chapter @@ -2637,7 +2637,7 @@ IMAGES= chapter1/fig1.png This will generate the following (emphasized text indicates the text that will - be the link); + be the link):
More information can be found in the first diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml index 5ad5d14f44..b126788a0b 100644 --- a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml @@ -96,7 +96,7 @@ document. The previous example is actually represented in this document like - this; + this: To remove /tmp/foo use &man.rm.1;. @@ -389,7 +389,7 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA Create example.sgml, and enter the - following text; + following text: @@ -424,7 +424,7 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA see if your document is valid or not. Use nsgmls to check that your document is - valid; + valid: &prompt.user; nsgmls -s example.sgml @@ -537,7 +537,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished declaration. A typical declaration for a document written to conform with version - 4.0 of the HTML DTD looks like this; + 4.0 of the HTML DTD looks like this: ]]> @@ -613,7 +613,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished FPIs must follow a specific syntax. This syntax is as - follows; + follows: "Owner//Keyword Description//Language" @@ -702,7 +702,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished In order to do this it can use a catalog file. A catalog file (typically called catalog) contains lines that map FPIs to filenames. For example, if the catalog file contained - the line; + the line: PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd" @@ -730,7 +730,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished colon-separated list of catalog files (including their full path). - Typically, you will want to include the following files; + Typically, you will want to include the following files: @@ -870,7 +870,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished -- back inside the comment -->]]> - The SGML parser will treat this as though it were actually; + The SGML parser will treat this as though it were actually: <!THIS IS OUTSIDE THE COMMENT> @@ -894,7 +894,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished Add some comments to example.sgml, and - check that the file still validates using nsgmls + check that the file still validates using nsgmls. @@ -936,7 +936,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished &entity-name;. For example, suppose you had an entity called current.version which expanded to the current - version number of your product. You could write; + version number of your product. You could write: The current version of our product is ¤t.version;.]]> @@ -953,7 +953,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished it assumes the next text will be the name of an entity. Fortunately, you can use the two general entities &lt; and - &amp; whenever you need to include one or other of these + &amp; whenever you need to include one or other of these. A general entity can only be defined within an SGML context. Typically, this is done immediately after the DOCTYPE @@ -1045,7 +1045,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished - Validate the document using nsgmls + Validate the document using nsgmls. @@ -1085,7 +1085,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished If you look at the output from sgmlnorm you will see that it does not include a DOCTYPE declaration at the start. To include this you need to use the - option; + option: &prompt.user; sgmlnorm -d example.sgml > example.html @@ -1171,7 +1171,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished First, place your entity definitions in a separate file, called chapters.ent. This file contains the - following; + following: @@ -1180,7 +1180,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished Now create a parameter entity to refer to the contents of the file. Then use the parameter entity to load the file into the document, which will then make all the general entities available - for use. Then use the general entities as before; + for use. Then use the general entities as before: @@ -1210,14 +1210,14 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished para2.sgml, and para3.sgml. - Put content similar to the following in each file; + Put content similar to the following in each file: This is the first paragraph.

]]> Edit example.sgml so that it looks like - this; + this: @@ -1267,7 +1267,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished Edit example.sgml so that it looks like - this; + this: %entities; @@ -1345,7 +1345,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished The marked section is finished by closing the two square brackets, and then returning to the document context from the SGML context with - > + >. Marked section keywords @@ -1492,7 +1492,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished ]]> When producing the hard-copy version, change the entity's - definition to; + definition to: <!ENTITY % electronic.copy "IGNORE"> @@ -1509,7 +1509,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished Create a new file, section.sgml, that - contains the following; + contains the following: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ <!ENTITY % text.output "INCLUDE"> @@ -1552,7 +1552,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished Change the definition of the text.output entity from INCLUDE to IGNORE. Re-normalize the file, and examine the - output to see what has changed. + output to see what has changed. diff --git a/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml index 3d9b8b2f5e..6c0953a65c 100644 --- a/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml @@ -40,18 +40,18 @@ - make it easy to automate converting the document to other formats + make it easy to automate converting the document to other formats; promote consistency between the different documentation organizations, to make it easier to switch between working on - different documents + different documents; make it easy to decide where in the tree new documentation should - be placed + be placed. diff --git a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml index 7b60650171..f1f5ab7a7d 100644 --- a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml @@ -45,7 +45,7 @@ Make sure your documentation ports are up to date! When in doubt, remove the old ports using &man.pkg.delete.1; command before installing the port. For example, we currently depend on - jade-1.2 and if you have installed jade-1.1, please do + jade-1.2 and if you have installed jade-1.1, please do: &prompt.root; pkg_delete jade-1.1 @@ -153,7 +153,7 @@ If you want to unset the variable ENGLISH_ONLY and build all pages, including translations, set the variable ENGLISH_ONLY - to an empty value + to an empty value: &prompt.root; make ENGLISH_ONLY="" all install clean diff --git a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml index 87a1bcd26f..a9a9249709 100644 --- a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml @@ -243,7 +243,7 @@ Finally, you should have directories for each document. For example, a hypothetical Swedish translation might look - like + like: doc/ sv_SE.ISO8859-1/ @@ -348,7 +348,7 @@ The entity names are defined in ISO8879, which is in the ports tree as textproc/iso8879. - A few examples include + A few examples include: Entity @@ -408,7 +408,7 @@ Yes. The header of the English version of each document will look - something like this; + something like this: <!-- The FreeBSD Documentation Project @@ -432,7 +432,7 @@ In addition, you should add a third line which indicates which revision of the English text this is based on. - So, the Spanish version of this file might start + So, the Spanish version of this file might start: <!-- The FreeBSD Spanish Documentation Project diff --git a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml index 873cf7cafa..d6f8a670d3 100644 --- a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml @@ -109,11 +109,11 @@ Use the command cvsup to update your - sources + sources. - Use cvsup to update your sources + Use cvsup to update your sources. These two examples show this for filenames. The second example @@ -139,7 +139,7 @@ - See &man.csh.1; + See &man.csh.1;. -- cgit v1.2.3