403 lines
7.2 KiB
HTML
403 lines
7.2 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>Tools for Writing, Editing and Maintaining your Document</TITLE
|
|
><META
|
|
NAME="GENERATOR"
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
|
|
REL="HOME"
|
|
TITLE="LDP Author Guide"
|
|
HREF="index.html"><LINK
|
|
REL="UP"
|
|
TITLE="Write"
|
|
HREF="write.html"><LINK
|
|
REL="PREVIOUS"
|
|
TITLE="Edit and Proofread the Text"
|
|
HREF="sg-editing.html"><LINK
|
|
REL="NEXT"
|
|
TITLE="Markup"
|
|
HREF="ag-markup.html"></HEAD
|
|
><BODY
|
|
CLASS="section"
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#840084"
|
|
ALINK="#0000FF"
|
|
><DIV
|
|
CLASS="NAVHEADER"
|
|
><TABLE
|
|
SUMMARY="Header navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TH
|
|
COLSPAN="3"
|
|
ALIGN="center"
|
|
>LDP Author Guide</TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="left"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="sg-editing.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="80%"
|
|
ALIGN="center"
|
|
VALIGN="bottom"
|
|
>Chapter 4. Write</TD
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="right"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="ag-markup.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H1
|
|
CLASS="section"
|
|
><A
|
|
NAME="tools-writing"
|
|
></A
|
|
>4.3. Tools for Writing, Editing and Maintaining your Document</H1
|
|
><DIV
|
|
CLASS="caution"
|
|
><P
|
|
></P
|
|
><TABLE
|
|
CLASS="caution"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="25"
|
|
ALIGN="CENTER"
|
|
VALIGN="TOP"
|
|
><IMG
|
|
SRC="../images/caution.gif"
|
|
HSPACE="5"
|
|
ALT="Caution"></TD
|
|
><TH
|
|
ALIGN="LEFT"
|
|
VALIGN="CENTER"
|
|
><B
|
|
>Reminder</B
|
|
></TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> </TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
VALIGN="TOP"
|
|
><P
|
|
> You do <EM
|
|
>not</EM
|
|
> need to submit your
|
|
initial document to the LDP in anything more than plain text! Other open
|
|
submission formats are accepted as well, for instance OpenOffice documents,
|
|
RTF files or HTML. The LDP volunteers will convert your document to DocBook
|
|
for you. Once it has been converted you will need to maintain your document
|
|
in DocBook format, but that should be obvious.
|
|
</P
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H2
|
|
CLASS="section"
|
|
><A
|
|
NAME="ag-edittools"
|
|
></A
|
|
>4.3.1. Editing Tools</H2
|
|
><P
|
|
> You may use any word processing or text editing tool to write your
|
|
initial document. When you get to the markup stage you may want to use
|
|
a text editor which recognizes DocBook files. At a minimum a program
|
|
which adds syntax highlighting to your markup will make life a lot
|
|
easier. For a description of editors which can handle DocBook files
|
|
please skip to <A
|
|
HREF="tools-edit.html"
|
|
>Section B.2</A
|
|
>.
|
|
</P
|
|
></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H2
|
|
CLASS="section"
|
|
><A
|
|
NAME="cvs-brief"
|
|
></A
|
|
>4.3.2. Concurrent Versions System (CVS)</H2
|
|
><P
|
|
> The LDP provides optional CVS access to its authors. This enables
|
|
collaborative writing and has the following positive effects:
|
|
</P
|
|
><P
|
|
></P
|
|
><OL
|
|
TYPE="1"
|
|
><LI
|
|
><P
|
|
> CVS will keep an off-site backup of your documents. In
|
|
the event that you hand over a document to another author,
|
|
they can just retrieve the document from CVS and continue
|
|
on. In the event you need to go back to a previous version of
|
|
a document, you can retrieve it as well. </P
|
|
></LI
|
|
><LI
|
|
><P
|
|
>However difficult from an organizational point of view, it's great to have multiple people working on the same
|
|
document. CVS enables you to do this. You can have CVS tell you what changes were made by another author
|
|
while you were editing your copy, and
|
|
integrate those changes.</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
>CVS keeps a log of what changes were made. These logs (and
|
|
a date stamp) can be placed automatically inside your documents
|
|
when they are published.
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> CVS can be combined with scripts to automatically
|
|
update the LDP web site with new documentation as it's written
|
|
and submitted. This is not in place yet, but it is a goal.
|
|
Currently, CVS updates signal the HOWTO coordinator to
|
|
update the LDP web page, meaning that if you use CVS, you're not
|
|
required to e-mail your XML code. (Although you do
|
|
still need to send the submit list an email when you
|
|
are ready for your document to be published, because the whole publishing process has not been fully automated yet.) </P
|
|
></LI
|
|
></OL
|
|
><DIV
|
|
CLASS="note"
|
|
><P
|
|
></P
|
|
><TABLE
|
|
CLASS="note"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="25"
|
|
ALIGN="CENTER"
|
|
VALIGN="TOP"
|
|
><IMG
|
|
SRC="../images/note.gif"
|
|
HSPACE="5"
|
|
ALT="Note"></TD
|
|
><TH
|
|
ALIGN="LEFT"
|
|
VALIGN="CENTER"
|
|
><B
|
|
>Access to our CVS repository</B
|
|
></TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> </TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
VALIGN="TOP"
|
|
><P
|
|
>Only authors with at least three submissions get access to our CVS, see <A
|
|
HREF="cvs.html"
|
|
>Appendix C</A
|
|
>.</P
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
><P
|
|
> For more information on how to use CVS to maintain your LDP
|
|
documents, please read <A
|
|
HREF="cvs.html"
|
|
>Appendix C</A
|
|
>.
|
|
</P
|
|
></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H2
|
|
CLASS="section"
|
|
><A
|
|
NAME="ag-spellcheck"
|
|
></A
|
|
>4.3.3. Spell Check</H2
|
|
><P
|
|
> Some writing tools will come with their own built-in spell
|
|
check tools. This list is only if your application does not
|
|
have a spell check option.
|
|
</P
|
|
><P
|
|
></P
|
|
><DIV
|
|
CLASS="variablelist"
|
|
><P
|
|
><B
|
|
>Spell Check Software</B
|
|
></P
|
|
><DL
|
|
><DT
|
|
><SPAN
|
|
CLASS="application"
|
|
>aspell</SPAN
|
|
>
|
|
<A
|
|
HREF="http://aspell.sourceforge.net"
|
|
TARGET="_top"
|
|
>http://aspell.sourceforge.net</A
|
|
></DT
|
|
><DD
|
|
><P
|
|
> This spell check application can work around XML tags. By
|
|
distinguishing between content and markup aspell is able to check
|
|
your content and ignore the bits it shouldn't be looking at. If you
|
|
are getting spelling errors in your markup tags you may be using an
|
|
old version and should upgrade.
|
|
</P
|
|
><P
|
|
>The <B
|
|
CLASS="command"
|
|
>aspell</B
|
|
> command comes with the <SPAN
|
|
CLASS="application"
|
|
>aspell</SPAN
|
|
> package, included on most Linux distributions. Use the command as follows:</P
|
|
><P
|
|
><B
|
|
CLASS="command"
|
|
>aspell <TT
|
|
CLASS="option"
|
|
>-c</TT
|
|
> <TT
|
|
CLASS="filename"
|
|
>file</TT
|
|
></B
|
|
> </P
|
|
><P
|
|
>An interactive user interface allows for fast and easy correction of errors. Use the <TT
|
|
CLASS="option"
|
|
>--help</TT
|
|
> to read more about <B
|
|
CLASS="command"
|
|
>aspell</B
|
|
> features.</P
|
|
></DD
|
|
><DT
|
|
><SPAN
|
|
CLASS="application"
|
|
>ispell</SPAN
|
|
>
|
|
<A
|
|
HREF="http://www.cs.hmc.edu/~geoff/ispell.html"
|
|
TARGET="_top"
|
|
>http://www.cs.hmc.edu/~geoff/ispell.html</A
|
|
></DT
|
|
><DD
|
|
><P
|
|
> Similar to <SPAN
|
|
CLASS="application"
|
|
>aspell</SPAN
|
|
>, but tries to spell
|
|
check your markup tags. If you have a choice, use
|
|
<SPAN
|
|
CLASS="application"
|
|
>aspell</SPAN
|
|
>, if not,
|
|
<SPAN
|
|
CLASS="application"
|
|
>ispell</SPAN
|
|
> is a very acceptable substitute.
|
|
</P
|
|
></DD
|
|
></DL
|
|
></DIV
|
|
></DIV
|
|
></DIV
|
|
><DIV
|
|
CLASS="NAVFOOTER"
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"><TABLE
|
|
SUMMARY="Footer navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="sg-editing.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="index.html"
|
|
ACCESSKEY="H"
|
|
>Home</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="ag-markup.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
>Edit and Proofread the Text</TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="write.html"
|
|
ACCESSKEY="U"
|
|
>Up</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>Markup</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |