LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

Added Vex and Conglomerate DocBook visual editors.

This commit is contained in:
emmajane 2005-01-24 03:42:43 +00:00
parent e9e26ea621
commit f0d07e12f6
2 changed files with 180 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

325
LDP/guide/docbook/LDP-Author-Guide/tools-text-editors.xml
View File

@ -21,150 +21,8 @@
some tweaking, handle DocBook files.
</para>
&configure-emacs;
<section id="tools-vim">
<title>VIM</title>
<indexterm><primary>vim</primary></indexterm>
<indexterm>
<primary>Editors</primary>
<secondary>vim</secondary>
</indexterm>
<para>
<ulink url="http://www.vim.org">http://www.vim.org</ulink>
</para>
<para>
No mention of text editors is complete
without talking about <application>vi</application>.
The <application>VIM</application> (Vi IMproved)
editor has the functionality of
regular vi and includes <quote>syntax
highlighting</quote> of tags.</para>
<section id="usingvim">
<title>Getting Started</title>
<para>
There are many versions of <application>vi</application>.
New authors will likely want one of the more
feature-packed versions for syntax highlighting and
a graphical interface including mouse control.
</para>
<para>
Red Hat users will want the following packages:
vim-common, vim-minimal and vim-enhanced.
Debian users will want the following package: vim.
For an X interface (including <acronym>GUI</acronym> menus and
mouse control) users will want
<application>gvim</application>. The <quote>g</quote> in gvim is for
<quote>Graphical</quote>.
</para>
<para><application>VIM</application> compiles very easy should you need to build your own. Both <command>vim</command> and <command>gvim</command> are built by default. Syntax highlighting is included but not enabled by default if you have to start from scratch; use the <command>:syntax enable</command> command in <application>VIM</application> to turn this feature on.
</para>
</section>
<section id="vim-new-file">
<title>Creating New DocBook XML Files</title>
<para>
In both <application>vim</application> and
<application>gvim</application>, <filename
class="extension">.xml</filename> files will be
recognized and enter into <quote>SGML mode</quote>.
A series of known DocBook tags and attributes have
been entered into <application>vim</application>
and will be highlighted one color if the name is known
and another if it is not (for this author the colors are yellow and blue).
</para>
<para>
Having the
correct document type declaration at the top of your
document should add the syntax highlighting.
If you do not see this highlighting you will need to
force VIM into SGML mode (even for XML files) using the
command <command>:set ft=sgml</command>. If you are
working with multiple files for a single XML document you
can add your document type in &lt;-- comments --&gt; to
the top of the file to get the correct syntax
highlighting (you will need to restart the program to see
the change in highlighting). The top line of this file
(<filename>tools-text-editors.xml</filename>) looks like this:
</para>
<screen>
<![CDATA[
<!-- <!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'> -->
]]>
</screen>
</section> <!-- vim-new-file -->
<section id="vim-spellcheck">
<title>Spell Check</title>
<para>
As in <application>Emacs</application>,
<application>Vim</application>, will work quite happily with
<application>aspell</application>. It can be run from within Vim
with the following:
<userinput>:! aspell -c %</userinput>.
</para>
<para>
For more sophisticated spell check alternatives, give <ulink
url="http://cream.sourceforge.net/">Cream</ulink> or <ulink
url="http://www.vim.org/scripts/script_search_results.php?keywords=vimspell&amp;script_type=&amp;order_by=rating&amp;direction=descending&amp;search=search">vimspell</ulink> a try.
</para>
</section>
<section id="vim-tagcompletion">
<title>Tag Completion</title>
<para>
The following information is provided by <ulink
url="http://www.digitalhermit.com">Kwan Lowe</ulink>.
</para>
<para>
Vim has a DocBook helper script which can be easily copied into
your <filename class="directory">.vimscripts</filename>
directory and used to <quote>auto complete</quote> tags while
writing DocBook documents. The script can be downloaded from:
<ulink url="http://www.vim.org/scripts/script.php?script_id=38"
/>.
</para>
<blockquote>
<para>
Grab the file, then untar it. Copy the
<filename>dbhelper.vim</filename> to your <filename
class="directory">.vimscripts</filename> directory if you have one.
</para>
<screen>
<prompt>$ </prompt><command>mkdir</command> <filename class="directory">.vimscripts</filename>
<prompt>$ </prompt><command>cp</command> <filename>dbhelper.vim</filename> <filename class="directory">.vimscripts</filename>
</screen>
<para>
You'll also have to convert the <filename>dbhelper.vim</filename> file to unix formatting:
</para>
<screen>
<prompt>$ </prompt><command>dos2unix</command> <filename>dbhelper.vim</filename>
</screen>
<para>
Next, edit your <filename>.vimrc</filename> file and add the line:
<userinput>source
/home/yourname/.vimscripts/dbhelper.vim</userinput>
</para>
<para>
To use the scripts, enter vi and go into insert mode. Press
<keycap>,</keycap> (comma) followed by the shortcut. For example:
<userinput>,dtbk</userinput>
</para>
</blockquote>
</section>
</section> <!-- vim -->
<section id="tools-epcEdit">
<title>epcEdit</title>
@ -218,6 +76,32 @@
</figure>
</section>
<section id="tools-morphoneditor">
<title>Morphon XML editor</title>
<para>
<ulink url="http://www.morphon.com/xmleditor/index.shtml">
http://www.morphon.com/xmleditor/index.shtml</ulink>
</para>
<para>
This is a commercial application which is currently
available for free (with an optional user registration).
It is written in Java, allowing it to run on any platform
that has a Java Virtual Machine (that is, works in both
Windows and Linux).
</para>
<para>
On the plus sides of <application>XMLEditor</application> is the left side of the
screen shows the hierarchy of the document (starting with Book
and so on). Selecting an item in the list brings you to that
part of the document so you can edit it. The right part of the
screen shows the text without any markup or tags being shown.
If you have external files as ELEMENTS (as the LDP Author Guide
does), <application>XMLEditor</application> will follow the links and load the files, so
you always work on the entire work. On the minus side of this,
you will get errors if a file is missing.
</para>
</section>
<section id="tools-nedit">
<title>nedit</title>
<indexterm><primary>nedit</primary></indexterm>
@ -392,32 +276,149 @@ turn it on explicitly using:
</section>
</section>
<section id="tools-morphoneditor">
<title>Morphon XML editor</title>
<section id="tools-vim">
<title>VIM</title>
<indexterm><primary>vim</primary></indexterm>
<indexterm>
<primary>Editors</primary>
<secondary>vim</secondary>
</indexterm>
<para>
<ulink url="http://www.morphon.com/xmleditor/index.shtml">
http://www.morphon.com/xmleditor/index.shtml</ulink>
<ulink url="http://www.vim.org">http://www.vim.org</ulink>
</para>
<para>
No mention of text editors is complete
without talking about <application>vi</application>.
The <application>VIM</application> (Vi IMproved)
editor has the functionality of
regular vi and includes <quote>syntax
highlighting</quote> of tags.</para>
<section id="usingvim">
<title>Getting Started</title>
<para>
There are many versions of <application>vi</application>.
New authors will likely want one of the more
feature-packed versions for syntax highlighting and
a graphical interface including mouse control.
</para>
<para>
This is a commercial application which is currently
available for free (with an optional user registration).
It is written in Java, allowing it to run on any platform
that has a Java Virtual Machine (that is, works in both
Windows and Linux).
Red Hat users will want the following packages:
vim-common, vim-minimal and vim-enhanced.
Debian users will want the following package: vim.
For an X interface (including <acronym>GUI</acronym> menus and
mouse control) users will want
<application>gvim</application>. The <quote>g</quote> in gvim is for
<quote>Graphical</quote>.
</para>
<para>
On the plus sides of <application>XMLEditor</application> is the left side of the
screen shows the hierarchy of the document (starting with Book
and so on). Selecting an item in the list brings you to that
part of the document so you can edit it. The right part of the
screen shows the text without any markup or tags being shown.
If you have external files as ELEMENTS (as the LDP Author Guide
does), <application>XMLEditor</application> will follow the links and load the files, so
you always work on the entire work. On the minus side of this,
you will get errors if a file is missing.
<para><application>VIM</application> compiles very easy should you need to build your own. Both <command>vim</command> and <command>gvim</command> are built by default. Syntax highlighting is included but not enabled by default if you have to start from scratch; use the <command>:syntax enable</command> command in <application>VIM</application> to turn this feature on.
</para>
</section>
<section id="vim-new-file">
<title>Creating New DocBook XML Files</title>
<para>
In both <application>vim</application> and
<application>gvim</application>, <filename
class="extension">.xml</filename> files will be
recognized and enter into <quote>SGML mode</quote>.
A series of known DocBook tags and attributes have
been entered into <application>vim</application>
and will be highlighted one color if the name is known
and another if it is not (for this author the colors are yellow and blue).
</para>
<para>
Having the
correct document type declaration at the top of your
document should add the syntax highlighting.
If you do not see this highlighting you will need to
force VIM into SGML mode (even for XML files) using the
command <command>:set ft=sgml</command>. If you are
working with multiple files for a single XML document you
can add your document type in &lt;-- comments --&gt; to
the top of the file to get the correct syntax
highlighting (you will need to restart the program to see
the change in highlighting). The top line of this file
(<filename>tools-text-editors.xml</filename>) looks like this:
</para>
<screen>
<![CDATA[
<!-- <!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'> -->
]]>
</screen>
</section> <!-- vim-new-file -->
<section id="vim-spellcheck">
<title>Spell Check</title>
<para>
As in <application>Emacs</application>,
<application>Vim</application>, will work quite happily with
<application>aspell</application>. It can be run from within Vim
with the following:
<userinput>:! aspell -c %</userinput>.
</para>
<para>
For more sophisticated spell check alternatives, give <ulink
url="http://cream.sourceforge.net/">Cream</ulink> or <ulink
url="http://www.vim.org/scripts/script_search_results.php?keywords=vimspell&amp;script_type=&amp;order_by=rating&amp;direction=descending&amp;search=search">vimspell</ulink> a try.
</para>
</section>
<section id="vim-tagcompletion">
<title>Tag Completion</title>
<para>
The following information is provided by <ulink
url="http://www.digitalhermit.com">Kwan Lowe</ulink>.
</para>
<para>
Vim has a DocBook helper script which can be easily copied into
your <filename class="directory">.vimscripts</filename>
directory and used to <quote>auto complete</quote> tags while
writing DocBook documents. The script can be downloaded from:
<ulink url="http://www.vim.org/scripts/script.php?script_id=38"
/>.
</para>
<blockquote>
<para>
Grab the file, then untar it. Copy the
<filename>dbhelper.vim</filename> to your <filename
class="directory">.vimscripts</filename> directory if you have one.
</para>
<screen>
<prompt>$ </prompt><command>mkdir</command> <filename class="directory">.vimscripts</filename>
<prompt>$ </prompt><command>cp</command> <filename>dbhelper.vim</filename> <filename class="directory">.vimscripts</filename>
</screen>
<para>
You'll also have to convert the <filename>dbhelper.vim</filename> file to unix formatting:
</para>
<screen>
<prompt>$ </prompt><command>dos2unix</command> <filename>dbhelper.vim</filename>
</screen>
<para>
Next, edit your <filename>.vimrc</filename> file and add the line:
<userinput>source
/home/yourname/.vimscripts/dbhelper.vim</userinput>
</para>
<para>
To use the scripts, enter vi and go into insert mode. Press
<keycap>,</keycap> (comma) followed by the shortcut. For example:
<userinput>,dtbk</userinput>
</para>
</blockquote>
</section>
</section> <!-- vim -->
<section id="tools-xxe">
<title>XMLmind XML Editor (XXE)</title>

17
LDP/guide/docbook/LDP-Author-Guide/tools-word-processors.xml
View File

@ -314,4 +314,21 @@ Office 2000)</title> <para>
</section> <!-- xmlmind -->
<section id="tools-conglomerate">
<title>Conglomerate</title>
<indexterm><primary>conglomerate</primary></indexterm>
<indexterm><primary>Editors</primary><secondary>conglomerate</secondary></indexterm>
<para><ulink url="http://www.conglomerate.org" /></para>
<para>According to their web site, <quote>Conglomerate aims to be an XML editor that everyone can use. In particular, our primary goal is to create the ultimate editor for DocBook and similar formats. It aims to hide the jargon and complexity of XML and present the information in your documents in a way that makes sense.</quote></para>
</section>
<section id="tools-vex">
<title>Vex: a visual editor for XML</title>
<para><ulink url="http://vex.sourceforge.net/" /></para>
<para>According to their web site, <quote>The visual part comes from the fact that Vex hides the raw XML tags from the user, providing instead a wordprocessor-like interface. Because of this, Vex is best suited for document-style XML documents such as XHTML and DocBook rather than data-style XML documents.</quote></para>
</section>
</section> <!-- tools-word-processors -->