diff options
author | Tammy Fox <tfox@redhat.com> | 2004-08-13 01:00:25 +0000 |
---|---|---|
committer | Tammy Fox <tfox@redhat.com> | 2004-08-13 01:00:25 +0000 |
commit | bd4ad402a3967db8b8903bf40d9fbb417a39d09e (patch) | |
tree | 58823492498112dc3791d35bcea7264531a5f06e | |
parent | c1daa457eb7ddcf856cca9adc00370fb9c99155a (diff) | |
download | documentation-guide-bd4ad402a3967db8b8903bf40d9fbb417a39d09e.tar.gz documentation-guide-bd4ad402a3967db8b8903bf40d9fbb417a39d09e.tar.xz documentation-guide-bd4ad402a3967db8b8903bf40d9fbb417a39d09e.zip |
general tag and style cleanup
-rw-r--r-- | docs-emacs-nxml-en.xml | 239 |
1 files changed, 139 insertions, 100 deletions
diff --git a/docs-emacs-nxml-en.xml b/docs-emacs-nxml-en.xml index 930585f..bfe6996 100644 --- a/docs-emacs-nxml-en.xml +++ b/docs-emacs-nxml-en.xml @@ -15,15 +15,22 @@ </indexterm> <para> - You can also use the nXML mode available for <application>Emacs</application> to make it even easier to write - in DockBook XML format. nXML mode provides context-sensitive editing using completion, real time validity error checking, - syntax highlighting and indentation. All you need to do is install an RPM!! + You can also use the nXML mode available for + <application>Emacs</application> to make it even easier to write in + DockBook XML format. nXML mode provides context-sensitive editing using + completion, real time validity error checking, syntax highlighting and + indentation. All you need to do is install an RPM!! </para> <note> <title>Early stages</title> <para> - Please be aware the nxml-mode for <application>Emacs</application> is quite new, so there are a few things that the advanced user might notice when using it with other documents types. If you keep an eye on the mailing-list, you can keep up to date with these, as well as ask questions. For more details, check out <xref linkend="s1-emacs-nxml-readme"></xref> + Please be aware the nxml-mode for <application>Emacs</application> is + quite new, so there are a few things that the advanced user might notice + when using it with other documents types. If you keep an eye on the + mailing-list, you can keep up to date with these, as well as ask + questions. For more details, check out <xref + linkend="s1-emacs-nxml-readme"></xref>. </para> </note> @@ -41,12 +48,19 @@ </indexterm> <para> - In order to use nXML mode with emacs, you will need to install the nXML RPM available from <ulink url="http://people.redhat.com/twaugh/ftp/docbook/nxml-mode/">Tim Waugh's</ulink> website or the source from <ulink url="http://www.thaiopensource.com/download/">www.thaiopensource.com/download/</ulink>. The source requires a lot more work to setup, therefore we will only be concentrating on the RPM version. + To use nXML mode with emacs, you will need to install the nXML RPM + available from <ulink + url="http://people.redhat.com/twaugh/ftp/docbook/nxml-mode/">Tim + Waugh's</ulink> website or the source from <ulink + url="http://www.thaiopensource.com/download/">http://www.thaiopensource.com/download/</ulink>. The + source requires a lot more work to setup, therefore we will only be + concentrating on the RPM version. </para> <para> - Information on where to get the source is available in <xref linkend="s1-emacs-additional-resources"></xref> - </para> + Information on where to get the source is available in <xref + linkend="s1-emacs-additional-resources"></xref>. + </para> </sect1> @@ -54,31 +68,49 @@ <title>Examples</title> <para> - Compared to PSGML mode there are only couple of commands that you need. This speeds up writing with Emacs considerably, which means you can concentrate more on the content of your article. + Compared to PSGML mode there are only couple of commands that you + need. This speeds up writing with <application>Emacs</application> + considerably, which means you can concentrate more on the content of + your article. </para> <sect2 id="s2-nxml-commands"> <title>Commands</title> <para> - To create a tag, just type <userinput><</userinput> and then type the keyword. To complete the keyword, press <command>Ctrl-Ret</command>, then add the last <userinput>></userinput>. To close a tag, type <userinput></</userinput>. + To create a tag, type <userinput><</userinput> and then type the + keyword. To complete the keyword, press <command>Ctrl-Ret</command>, + then add the last <userinput>></userinput>. To close a tag, type + <userinput></</userinput>. </para> <important> - <title>Using vacuous schema</title> - <para>When you open a document that doesn't have a DOCTYPE declaration at the top of the file, you will get this message and tag completion won't work because nXML will not know what format you are writing. + <title>Important</title> + <para> + When you open a document that doesn't have a DOCTYPE declaration at + the top of the file, you will get this message and tag completion + won't work because nXML will not know what format you are writing. </para> </important> <para> - To load the schema, type <command>Ctrl-c</command>, then <command>Ctrl-s</command> and navigate to <filename>/usr/share/emacs/site-lisp/nxml-mode/schema</filename> and load <filename>docbook.rnc</filename>. <application>Emacs</application> will then prompt you to save it in the current working directory. + To load the schema, type <command>Ctrl-c</command>, then + <command>Ctrl-s</command> and navigate to + <filename>/usr/share/emacs/site-lisp/nxml-mode/schema/</filename> and + load + <filename>docbook.rnc</filename>. <application>Emacs</application> + will then prompt you to save it in the current working directory. </para> <tip> - <title>Don't forget</title> + <title>Tip</title> <para> - The commands already discussed are the only differences between using <application>Emacs</application> with PSGML mode and <application>Emacs</application> with nXML mode. You will still need to use all the same commands as discussed in <xref linkend="s1-emacs-basic-commands"></xref>. + The commands already discussed are the only differences between + using <application>Emacs</application> with PSGML mode and + <application>Emacs</application> with nXML mode. You will still need + to use all the same commands as discussed in <xref + linkend="s1-emacs-basic-commands"></xref>. </para> </tip> </sect2> @@ -87,40 +119,48 @@ <sect1 id="s1-emacs-nxml-additional-resources"> <title>Additional Resources</title> - <para> Additional Emacs and nXML references are available at the - following locations: + <para> + Additional Emacs and nXML references are available at the following + locations: </para> <itemizedlist> <listitem> - <para><ulink url="http://www.thaiopensource.com/download/">http://www.thaiopensource.com/download/</ulink> — <citetitle>Author's download area</citetitle> + <para><ulink + url="http://www.thaiopensource.com/download/">http://www.thaiopensource.com/download/</ulink> + — <citetitle>Author's download area</citetitle> </para> </listitem> <listitem> - <para> - <ulink url="http://wks.uts.ohio-state.edu/unix_course/intro-135.html">http://wks.uts.ohio-state.edu/unix_course/intro-135.html</ulink> + <para><ulink + url="http://wks.uts.ohio-state.edu/unix_course/intro-135.html">http://wks.uts.ohio-state.edu/unix_course/intro-135.html</ulink> — <citetitle>Emacs Quick Reference Guide</citetitle> </para> </listitem> - <listitem> <para>Emacs reference card that comes with the - <filename>emacs</filename> package. You can print it out as a - reference. — - <filename>/usr/share/emacs/<replaceable><version></replaceable>/etc/refcard.ps</filename> + <listitem> + <para>Emacs reference card that comes with the + <filename>emacs</filename> package. You can print it out as a + reference. — + <filename>/usr/share/emacs/<replaceable><version></replaceable>/etc/refcard.ps</filename> </para> </listitem> </itemizedlist> </sect1> <sect1 id="s1-emacs-nxml-readme"> - <title>nXML README file</title> + <title>nXML README File</title> <note> - <para> - This file can be found in the directory you extracted the source into, or in <filename>/usr/share/doc/nxml-mode-<replaceable><version></replaceable>/</filename> if you installed the RPM. - </para> + <title>Note</title> + <para> + This file can be found in the directory you extracted the source + into, or in + <filename>/usr/share/doc/nxml-mode-<replaceable><version></replaceable>/</filename> + if you installed the RPM. + </para> </note> -<para>README file:</para> + <para>README file:</para> <para> This is a new major mode for GNU Emacs for editing XML documents. It @@ -132,94 +172,95 @@ <para> To use this, you need GNU Emacs version 21.x, preferably 21.3. GNU Emacs version 20 will not work properly, nor will XEmacs. - To get started, do + To get started, do the following: </para> - <para> - <command> M-x load-file RET rng-auto.el RET</command> - </para> +<screen> +<command>M-x load-file RET rng-auto.el RET</command> +</screen> <para> This defines the necessary autoloads. Now, visit a file containing - an XML document, and do + an XML document, and do the following: </para> - <para> - <command>M-x nxml-mode</command> - </para> +<screen> +<command>M-x nxml-mode</command> +</screen> <para> Now do </para> - <para> - <command>C-h m</command> - </para> +<screen> +<command>C-h m</command> +</screen> <para> - For information on how to use nxml-mode. - The beginnings of a manual are in nxml-mode.info. You can read this using + For information on how to use nxml-mode. The beginnings of a manual are + in nxml-mode.info. You can read this using: </para> +<screen> +<command>C-u M-x info RET nxml-mode.info RET</command> +</screen> <para> - <command>C-u M-x info RET nxml-mode.info RET</command> + It's also installed as an entry at the end of the top-level info + directory. So you can read it with <command>C-h i</command> as usual. </para> <para> - It's also installed as an entry at the end of the top-level info - directory. So you can read it with <computeroutput>C-h i</computeroutput> as usual. + You can use <filename>test.valid.xml</filename> and + <filename>test.invalid.xml</filename> as examples of valid and invalid + XML documents. </para> + <para> - You can use test.valid.xml and test.invalid.xml as examples of valid - and invalid XML documents. + To get things automatically loaded each time you start Emacs, add: </para> - <para> - To get things automatically loaded each time you start Emacs, add - - <screen> - <computeroutput> +<screen> +<computeroutput> (load "~/nxml-mode-200YMMDD/rng-auto.el") - </computeroutput> - </screen> - - to your .emacs, where ~/nxml-mode-200YMMDD is the directory containing -the <filename>.elc</filename> files. Note that <filename>rng-auto.el</filename> does not load all of the -nxml-mode code; it merely sets things up so that all the features of -nxml-mode will be autoloaded properly. You should not try to autoload -<filename>rng-auto.el</filename> itself. +</computeroutput> +</screen> + + <para> + to your <filename>.emacs</filename>, where + <computeroutput>~/nxml-mode-200YMMDD</computeroutput> is the directory + containing the <filename>.elc</filename> files. Note that + <filename>rng-auto.el</filename> does not load all of the nxml-mode + code; it merely sets things up so that all the features of nxml-mode + will be autoloaded properly. You should not try to autoload + <filename>rng-auto.el</filename> itself. </para> <para> -To use nxml-mode automatically for files with an extension of xml, -xsl, rng or xhtml, add + To use nxml-mode automatically for files with an extension of + <filename>xml</filename>, <filename>xsl</filename>, + <filename>rng</filename> or <filename>xhtml</filename>, add the + following to your <filename>.emacs</filename> file: </para> - <screen> - <computeroutput> +<screen> +<computeroutput> (setq auto-mode-alist (cons '("\\.\\(xml\\|xsl\\|rng\\|xhtml\\)\\'" . nxml-mode) auto-mode-alist)) - </computeroutput> - </screen> - <para> - to your .emacs. - </para> - - <para> - If you edit XML using iso-8859-N encodings other than iso-8859-1 and - you are running Emacs 21.3 or later, then I recommend enabling - unify-8859-on-decoding-mode, by adding - </para> +</computeroutput> +</screen> <para> - <command>(unify-8859-on-decoding-mode)</command> + If you edit XML using iso-8859-N encodings other than iso-8859-1 and you + are running Emacs 21.3 or later, then I recommend enabling + unify-8859-on-decoding-mode, by adding the following to your + <filename>.emacs</filename> file: </para> - <para> - to your <filename>.emacs.</filename> - </para> +<screen> +<computeroutput>(unify-8859-on-decoding-mode)</computeroutput> +</screen> <para> To get validation and schema-sensitive editing, you need a RELAX NG @@ -228,15 +269,19 @@ xsl, rng or xhtml, add </para> <para> - For more on RELAX NG, see <ulink url="http://relaxng.org">http://relaxng.org</ulink> + For more on RELAX NG, refer to <ulink + url="http://relaxng.org/">http://relaxng.org/</ulink>. </para> <para> - For a tutorial on RELAX NG Compact Syntax, see <ulink url="http://relaxng.org/compact-tutorial.html">http://relaxng.org/compact-tutorial.html</ulink> + For a tutorial on RELAX NG Compact Syntax, refer to <ulink + url="http://relaxng.org/compact-tutorial.html">http://relaxng.org/compact-tutorial.html</ulink> </para> <para> - For automatically creating RNC schemas, I recommend my Trang program: <ulink url="http://www.thaiopensource.com/relaxng/trang.html">http://eee.thaiopensource.com/relaxng/trang.html"</ulink> + For automatically creating RNC schemas, I recommend my Trang program: + <ulink + url="http://www.thaiopensource.com/relaxng/trang.html">http://eee.thaiopensource.com/relaxng/trang.html"</ulink> </para> <para> @@ -245,39 +290,42 @@ xsl, rng or xhtml, add <itemizedlist> <listitem> <para> - infer an RNC schema from an instance document; + Infer an RNC schema from an instance document </para> </listitem> <listitem> <para> - convert a DTD to an RNC schema; + Convert a DTD to an RNC schema </para> </listitem> <listitem> <para> - convert a RELAX NG XML syntax schema to an RNC schema. + Convert a RELAX NG XML syntax schema to an RNC schema </para> </listitem> </itemizedlist> </para> <para> - To convert a RELAX NG XML syntax (.rng) schema to a RNC schema, you - can also use the XSLT stylesheet from <ulink url="http://www.pantor.com/download.html">http://www.pantor.com/download.html"</ulink> + To convert a RELAX NG XML syntax (.rng) schema to a RNC schema, you can + also use the XSLT stylesheet from <ulink + url="http://www.pantor.com/download.html">http://www.pantor.com/download.html"</ulink>. </para> <para> - To convert a W3C XML Schema to an RNC schema, you need first to - convert it to RELAX NG XML syntax using Sun's RELAX NG converter tool - rngconv (built on top of MSV). See <ulink url="https://msv.dev.java.net/">https://www.dev.java.net/</ulink> + To convert a W3C XML Schema to an RNC schema, you need first to convert + it to RELAX NG XML syntax using Sun's RELAX NG converter tool rngconv + (built on top of MSV). Refer to <ulink + url="https://msv.dev.java.net/">https://www.dev.java.net/</ulink>. </para> <para> - The file NEWS describes recent changes. + The file <filename>NEWS</filename> describes recent changes. </para> <para> - Please use the list <ulink url="http://groups.yahoo.com/group/emacs-nxml-mode/">http://groups.yahoo.com/group/emacs-nxml-mode</ulink> + Please use the list <ulink + url="http://groups.yahoo.com/group/emacs-nxml-mode/">http://groups.yahoo.com/group/emacs-nxml-mode</ulink> for bug reports, discussion. I will announce all new versions there. </para> @@ -289,12 +337,3 @@ xsl, rng or xhtml, add </para> </sect1> </chapter> - - - - - - - - - |