Diff for "DocBookEditors"

Differences between revisions 15 and 48 (spanning 33 versions)
⇤ ← Revision 15 as of 2006-04-06 02:33:09 →
Size: 4674
Editor: 69-174-138-89
Comment:
← Revision 48 as of 2011-03-16 21:39:08 → ⇥
Size: 11689
Editor: adsl-66-120-86-154
Comment: Fixed broken link
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents>>||
Line 7: Line 8:
== Format ==
=== program (+ plugin1 / plugin2 ...) ===
  * repository: main / universe
  * environment: Gnome / KDE / Java / command-line / ?
  * homepage: project homepage
  * install: apt-get install ...
  * community: program community resources link
  * comments: comment 1
    * comment 2		 The questions that I am trying to help you to answer for yourself are...
  * How easy or hard is it going to be for me to get this program?
  * How easy or hard is it going to be for me to install this program?
  * How much help am I going to need and will I be able to get it?
  * Will the look and feel of the app be comfortable to me?
Line 18: Line 16:
  * http://cvs.sourceforge.net/viewcvs.py/docbook/testdocs/tests/   * https://docbook.svn.sourceforge.net/svnroot/docbook/trunk/testdocs/tests/
Line 20: Line 18:
These programs are available from the Ubuntu package repositories. These programs are available from the Ubuntu package repositories. Packages in the "main" repository should be well supported by the Ubuntu community. Packages in the "universe" repository are contributed by smaller groups or individuals and may not be as well-supported.
Line 23: Line 22:
  * environment: GTK2 / Gnome2   * environment: GTK2 / GNOME
Line 25: Line 24:
  * install: apt-get install abiword abiword-common abiword-plugins   * install: {{{abiword abiword-common abiword-plugins}}}
Line 27: Line 26:
  * comments: I'm having problems importing DocBook, but it should work, I need to RTFM   * comments: I'm having problems importing DocBook, but it should work
Line 30: Line 30:
  * environment: Gnome   * environment: GNOME
Line 32: Line 32:
  * install: apt-get install bluefish   * install: {{{bluefish}}}
Line 35: Line 35:
Line 37: Line 38:
  * environment: Gnome   * environment: GNOME
Line 39: Line 40:
  * install: apt-get install conglomerate   * install: {{{conglomerate}}}
Line 43: Line 44:
Line 47: Line 49:
  * install: apt-get install nxml-mode   * install: {{{nxml-mode}}}
Line 50: Line 52:

=== geany ===
  * environment: GTK2
  * homepage: http://geany.uvena.de/
  * install: {{{geany}}}
  * community: http://geany.uvena.de/support.html
  * comments: very lightweight, but still includes syntax highlighting, auto tag-closing for xml, and more
Line 54: Line 64:
  * install: apt-get install kate kate-plugins   * install: {{{kate kate-plugins}}}
Line 59: Line 69:

=== gedit ===
  * repository: main
  * environment: GNOME
  * homepage: http://www.gnome.org/projects/gedit
  * install: {{{gedit}}}
  * community:
  * comments: installed by default with Ubuntu

=== lyx ===
  * repository: universe
  * environment: Qt / xforms
  * homepage: http://www.lyx.org
  * install: {{{lyx}}}
  * community: http://www.lyx.org/internet/
  * comments: LaTeX oriented but can import / export DocBook
    * What You See Is What You Mean (WYSIWYM) works beautifully
    * templates seem to be broken at the moment
Line 63: Line 92:
  * install: apt-get install mlview   * install: {{{mlview}}}
Line 66: Line 95:
Line 70: Line 100:
  * install: apt-get install openoffice.org   * install: {{{openoffice.org}}}
Line 72: Line 102:
  * comments: I have not been able to get OOo to work with DocBook on Linux   * comments: OOo3 Writer allows to save (File/Save as…) any document (ODF or html) as docbook (defaults to an "article", not a "book") and reopen it for editing. The structuration of the docbook (sections) depends on the systematic use of the Heading 1, 2, 3, etc. of the word processor.
Line 74: Line 104:

=== Quanta+ ===
  * repository: main
  * environment: KDE
  * homepage: http://quanta.kdewebdev.org/
  * install: {{{quanta}}}
  * community: http://quanta.kdewebdev.org/bugs.php
  * comments: looks similar to kate, but has some nice tools for validation etc.
    * doesn't have the DocBook 4.3 XML DTD out of the box
    * no missing dependencies in Kubuntu dapper
    * in Ubuntu dapper, a few dependency problems
      * a few needed packages are not installed by "apt-get quanta"
      * installing kubuntu-desktop is one easy way to fix it
      * I should try to find out what extra packages I needed to install
        * then I should report it as a bug!
    * on Ubuntu dapper, sometimes it freezes for me
    * excellent tutorial http://quanta.kdewebdev.org/tutorials/quanta-docbook/quanta.html
Line 78: Line 126:
  * install: apt-get install scite   * install: {{{scite}}}
Line 82: Line 130:
Line 86: Line 135:
  * install: apt-get install vim   * install: console {{{vim}}} comes installed by default, gtk frontend is {{{vim-gtk}}}
Line 88: Line 137:
  * comments: good option if you like vim / vi   * comments:
   * VimHowto
   * [[http://www.pinkjuice.com/howto/vimxml/tasks.xml|Vim as an XML Editor]]
   * [[http://vim.wikia.com/wiki/Vim_as_XML_Editor|Vim as an XML Editor at Vim Wiki (see comments)]]
   * Vim also supports many features like code folding, spell checking, <your favourite feature>
Line 91: Line 145:

=== Butterfly XML ===
  * environment: Java
  * homepage: http://www.butterflyxml.org/
  * install: http://www.butterflyxml.org/modules.php?name=Downloads
  * community: http://www.butterflyxml.org/modules.php?name=Forums
  * comments: screenshots look intriguing, haven't tried it yet
Line 98: Line 159:
    * once I got the hang of the XML plugins and debug functions, I think this is my favorite XML editor so far

=== Vex ===
  * environment: Java / Eclipse
  * component: Eclipse
  * homepage: http://vex.sourceforge.net/
  * install: http://vex.sourceforge.net/install.html
  * community: http://sourceforge.net/mailarchive/forum.php?forum_id=41623
  * comments: doesn't support Xinclude, other than that a very nice editor interface based on Eclipse 3.0
    * can also be used as a plugin for Eclipse, but works best with 1.4 JVM and Eclipse 3.0
    * I couldn't get it to work with 1.5 JVM and Eclipse 3.1.2
    * interesting whitepaper from IBM http://www.eclipse.org/articles/Article-Authoring-With-Eclipse/AuthoringWithEclipse.html

== Commercial Applications ==
These programs require you to pay money for a license, but usually included in that price is professional support from the program vendor. Several of these programs also have a Lite version with several features disabled. Lite versions are usually free for personal use but restricted.

=== Editix XML Editor (EditiX) ===
  * environment: Java
  * homepage: http://www.editix.com/
  * lite: http://www.editix.com/download.html (30 day trial)
  * community: http://www.editix.com/contact.html
  * comments: ~+not+~ Open Source, no free version only 30 day trial
    * haven't tried it yet

=== Exchanger XML Editor (EXE) ===
  * environment: Java
  * homepage: http://www.exchangerxml.com/
  * lite: http://www.freexmleditor.com/
  * community: http://exchangerxml.com/phpBB2/
  * comments: ~+not+~ Open Source, free to use but restricted
    * haven't tried it yet

=== oXygen XML Editor ===
  * environment: Java
  * homepage: http://www.oxygenxml.com/xml_editor.html
  * lite: n/a 30-day free demo
  * community: http://www.oxygenxml.com/forum/
  * comments: Eclipse and SVN integration look nice

=== XMLBuddy ===
  * environment Java / Eclipse
  * component: Eclipse
  * homepage: http://www.xmlbuddy.com/ (XMLBuddy Pro)
  * lite: http://www.xmlbuddy.com/ (XMLBuddy)
  * community: ?
  * comments: looks like it could be a little old (2003?) but will give it a try
    * if the company name was "boca loca" that would mean "crazy mouth" in Spanish

=== XMLmind XML Editor (XXE) ===
  * environment: Java
  * homepage: http://www.xmlmind.com/xmleditor/
  * lite: http://www.xmlmind.com/xmleditor/stdedition.html
  * community: http://www.xmlmind.com/mailman/listinfo/xmleditor-support
  * comments: ~+not+~ Open Source, free to use but restricted
    * very nice interface nearly WYSIWYG, I think this is my 2nd favorite
    * supports Xincludes and can inline content including most graphics
    * sometimes adds blank lines or messes up indents when you look at the raw XML

== Dead Projects ==
These are programs which appear to be abandoned by the author. I have included them here to answer the question, "But what about program <X>?" If you are a developer and you really like the program, perhaps you could contact the author to ask about resuming development or creating a fork.
=== moleskine ===
  * environment: Gnome
  * component: Scintilla
  * homepage: http://micampe.it/things/moleskine
  * install: http://micampe.it/things/moleskine
  * community:
  * comments:

== Editor Components ==
Peeking at the source code, I found there is similarity between many of the programs because they are based on the same widget set or editor component. For example SciTE and Geany are both based on the Scintilla code editor component, while bluefish and gedit are based on the GtkSourceView component. The component that is used controls how the editor displays and manages code folding and syntax highlighting for example. I think it would be a useful exercise to identify the editor component used by each application.
Line 102: Line 233:
  * lyx
  * quanta
  * butterfly
  * exchanger lite
  * geany
Additions
  * use tabs to make attributes align better?		   * nice list on http://www.tldp.org/LDP/LDP-Author-Guide/html/tools-edit.html
  * check programs listed on http://scintilla.sourceforge.net/ScintillaRelated.html
    * PyPE
    * CUTE http://cute.sourceforge.net/index.html
  * any other editor components akin to Scintilla?
  * Jext http://www.jext.org/
  * Code Browser http://code-browser.sourceforge.net/
  * GtkEditor component http://gtkeditor.sourceforge.net/
  * stylus / pilot ?
  * adobe pagemaker ?
Line 110: Line 244:
CategoryDocteam CategoryOffice

Goals

The goals of this page are...

  • to be a comprehensive list of DocBook-aware editor programs

  • to distinguish which programs are included in Ubuntu
  • to present this information in a consistent format

  • please try to stick to the format thank you Smile :)

The questions that I am trying to help you to answer for yourself are...

  • How easy or hard is it going to be for me to get this program?
  • How easy or hard is it going to be for me to install this program?
  • How much help am I going to need and will I be able to get it?
  • Will the look and feel of the app be comfortable to me?

Test Suite

You can find many sample documents in the DocBook SourceForge CVS Repository which may be useful to exercise program features:

Supported

These programs are available from the Ubuntu package repositories. Packages in the "main" repository should be well supported by the Ubuntu community. Packages in the "universe" repository are contributed by smaller groups or individuals and may not be as well-supported.

abiword

bluefish

conglomerate

emacs + nxml

geany

kate

  • repository: main
  • environment: KDE

  • homepage: http://kate.kde.org/

  • install: kate kate-plugins

  • community: http://kate.kde.org/contact.php

  • comments: installed by default with Kubuntu
    • great option for kate, use it for all my editing
    • code folding / unfolding is handled very nicely

gedit

lyx

  • repository: universe
  • environment: Qt / xforms

  • homepage: http://www.lyx.org

  • install: lyx

  • community: http://www.lyx.org/internet/

  • comments: LaTeX oriented but can import / export DocBook

    • What You See Is What You Mean (WYSIWYM) works beautifully
    • templates seem to be broken at the moment

mlview

OpenOffice.org Writer

  • repository: main
  • environment: (originally Java, but now ?)

  • homepage: http://www.openoffice.org

  • install: openoffice.org

  • community: http://support.openoffice.org/index.html

  • comments: OOo3 Writer allows to save (File/Save as…) any document (ODF or html) as docbook (defaults to an "article", not a "book") and reopen it for editing. The structuration of the docbook (sections) depends on the systematic use of the Heading 1, 2, 3, etc. of the word processor.

Quanta+

  • repository: main
  • environment: KDE

  • homepage: http://quanta.kdewebdev.org/

  • install: quanta

  • community: http://quanta.kdewebdev.org/bugs.php

  • comments: looks similar to kate, but has some nice tools for validation etc.

    • doesn't have the DocBook 4.3 XML DTD out of the box

    • no missing dependencies in Kubuntu dapper
    • in Ubuntu dapper, a few dependency problems
      • a few needed packages are not installed by "apt-get quanta"
      • installing kubuntu-desktop is one easy way to fix it
      • I should try to find out what extra packages I needed to install
        • then I should report it as a bug!
    • on Ubuntu dapper, sometimes it freezes for me

    • excellent tutorial http://quanta.kdewebdev.org/tutorials/quanta-docbook/quanta.html

SciTE

vim + xmledit

Unsupported

These programs are not available in the Ubuntu package repositories. Some packages may not be included due to licensing restrictions. Perhaps you would like to volunteer to package one of these programs for Ubuntu? There is certainly nothing wrong with using these programs, but you may need to turn to their own user community if you need assistance.

Butterfly XML

jEdit + XML / XmlIndenter / XQuery / XSLT / JTidyPlugin

Vex

Commercial Applications

These programs require you to pay money for a license, but usually included in that price is professional support from the program vendor. Several of these programs also have a Lite version with several features disabled. Lite versions are usually free for personal use but restricted.

Editix XML Editor (EditiX)

Exchanger XML Editor (EXE)

oXygen XML Editor

XMLBuddy

  • environment Java / Eclipse
  • component: Eclipse

  • homepage: http://www.xmlbuddy.com/ (XMLBuddy Pro)

  • lite: http://www.xmlbuddy.com/ (XMLBuddy)

  • community: ?
  • comments: looks like it could be a little old (2003?) but will give it a try
    • if the company name was "boca loca" that would mean "crazy mouth" in Spanish

XMLmind XML Editor (XXE)

Dead Projects

These are programs which appear to be abandoned by the author. I have included them here to answer the question, "But what about program <X>?" If you are a developer and you really like the program, perhaps you could contact the author to ask about resuming development or creating a fork.

moleskine

Editor Components

Peeking at the source code, I found there is similarity between many of the programs because they are based on the same widget set or editor component. For example SciTE and Geany are both based on the Scintilla code editor component, while bluefish and gedit are based on the GtkSourceView component. The component that is used controls how the editor displays and manages code folding and syntax highlighting for example. I think it would be a useful exercise to identify the editor component used by each application.

To Do List

Programs to add

CategoryOffice

DocBookEditors (last edited 2012-03-26 17:40:40 by guise)