diff --git a/LDP/guide/docbook/LDP-Author-Guide/ag-maintain.xml b/LDP/guide/docbook/LDP-Author-Guide/ag-maintain.xml index bbeed8ef..2ec0dc8d 100644 --- a/LDP/guide/docbook/LDP-Author-Guide/ag-maintain.xml +++ b/LDP/guide/docbook/LDP-Author-Guide/ag-maintain.xml @@ -2,25 +2,22 @@ --> - Maintaining Your HOWTO +Maintenance - - Just because your document has now been published doesn't mean your +
+Maintaining Your Document + Just because your document has now been published does not mean your job is done. Linux documentation needs regular maintenance to make sure it is up to date, and to improve it in response to readers' ideas and suggestions. TLDP is a living, growing body of knowledge, - not just a publish-and-forget-it static entity. - + not just a publish-and-forget-it static entity. - - Add relevant mailing lists to your document where people + Add relevant mailing lists to your document where people can get support. If you have the time, follow these mailing lists yourself to stay up-to-date on the - latest information. - + latest information. - - Put your email address in the document, and politely request + Put your email address in the document, and politely request feedback from your readers. Once you are officially published, you will begin to receive notes with suggestions. Some of these emails will be very valuable. Create a @@ -29,10 +26,9 @@ the folder and make updates to your document. If you are following a related mailing list you may also choose to save a copy of important emails from the list to - this folder. - + this folder. - We're not a free support service, but... + We are not a free support service, but... Some people who email you will request personal assistance. You should feel free to decline personal assistance if you cannot spare the time. Writing a @@ -41,39 +37,29 @@ to reply to all requests and suggest a mailing list that will (hopefully) be able to provide support to your reader. - - +
+
Fixing Errors - - If you find an error in your own document, please fix it - and re-submit it. You can re-submit your files by emailing - them to submit@en.tldp.org. If you've been - using the CVS, you can simply cvs commit your revised document - and then send an email saying the new version is ready for - distribution. Remember to update the revision history at the - top of the document. - - - - If you find an error in someone else's document please - contact the author of the document, or the LDP - coordinator at discuss@en.tldp.org (subscription - required) and - mention the problem and how you think it needs to be - fixed. - - - Taking over unmaintained documentation - For more information on how to deal with unmaintained - documents, please read: - Unmaintained - (includes a list of steps to take to take over - ownership of unmaintained documents, and a - list of unmaintained documents). - -
+
+ Fixing Your Own Documents + If you find an error in your own document, please fix it and re-submit the document. You can re-submit your files by emailing them to submit@en.tldp.org. + + If you have been using the CVS, you can submit your changes to the CVS tree and then send a note to the submit mailing list (submit@en.tldp.org). In your email please give the exact path of your document in the CVS tree. + + Remember to update the revision history at the top of the document. +
+ +
+ Fixing Other Documents in the Collection + If you find an error in someone else's document please contact the author of the document with the correction. If you do not hear back from the author within a reasonable amount of time, please email the LDP coordinator at discuss@en.tldp.org (subscription required) and describe the problem and how you think it needs to be fixed. If the license permits, you may be asked to make the change directly to the document. If the problems are serious, the document may be removed from the collection, or moved to the Unmaintained section. + + + Taking over unmaintained documentation + For more information on how to deal with unmaintained documents, please read: Unmaintained (includes a list of steps to take to take over ownership of unmaintained documents, and a list of unmaintained documents). + +
+ + diff --git a/LDP/guide/docbook/LDP-Author-Guide/tools-transform.xml b/LDP/guide/docbook/LDP-Author-Guide/tools-transform.xml index cb42cd72..5bb91d50 100644 --- a/LDP/guide/docbook/LDP-Author-Guide/tools-transform.xml +++ b/LDP/guide/docbook/LDP-Author-Guide/tools-transform.xml @@ -3,12 +3,10 @@ -->
Transformations - TLDP can convert your document - This section is about how to transform documents - from DocBook to other formats. If you do not want - to transform documents on your own computer you may - skip this section. - + TLDP will convert your document + This section is about how to transform documents + from DocBook to other formats. If you do not need + to transform documents for your own web site, or to proof read the content, please skip this section. If you would like to transform your documents for @@ -22,14 +20,12 @@ either absolute or relative URIs. - - Another fairly straight-forward package is + Another easy-to-use package is xmlto. It is a front-end for xsltproc. It is available as a RedHat, Debian (etc) package or can be downloaded from . You can use it to convert - documents with: - + documents with: bash$ xmlto html mydoc.xml