Home ›

Vim Macros for Editing DocBook Documents

Aug 26, 2004  By Mitch Frazier
 in
Macros for key mappings, tags and entities that can be used with DocBook/XML and other similar markup languages.
Conculsion

If you're a vim user and you need to edit DocBook, the macros described here can make your job easier by providing you with vim key bindings for inserting tags and entities, as well as for inserting predefined tag templates. It also provides key bindings that allow you to move tags in your document and to move through your document by way of tags.

Although originally designed for use with DocBook/XML, these macros could be used with any similar markup language, such as HTML, SGML or other XML-based markup languages.

Resources

Official Home of DocBook The DocBook DTD is available here.

On-line version of the O'Reilly book DocBook: The Definitive Guide The DocBook DTD also is available here.

Vim Editor

Xerces XML Parser and Xalan XSL Stylesheet processors

DocBook to HTML Stylesheet

______________________

Mitch Frazier is an Associate Editor for Linux Journal.

Comments

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.

Re: Vim Macros for Editing DocBook Documents

Anonymous's picture
Submitted by Anonymous on Fri, 08/27/2004 - 02:00.

i copied the 4 macro files in the article, but i get the following errors when doing, ":so maps.vim"...

i xb

i xc [CDATA[-:-]]?-:-3xi
Error detected while processing function MapTagKey:
line 57:
E121: Undefined variable: etag
E15: Invalid expression: "imap " . s:InsertEndTagKey . a:key . eicmd . etag
line 58:
E121: Undefined variable: etag
E15: Invalid expression: "nmap " . s:InsertEndTagKey . a:key . encmd . etag
line 61:
E121: Undefined variable: etag
E116: Invalid arguments for function escape(etag, """)
E15: Invalid expression: escape(etag, """)

it sort of just gets worse from there...

Re: Vim Macros for Editing DocBook Documents

Anonymous's picture
Submitted by Anonymous on Wed, 09/01/2004 - 02:00.

It works now when downoading the files from the LJ server.

But there is a bug that inserts closing tags...

For example:

<F2><n> produces:

<itemizedlist>
<listitem><para></para></listitem>
</itemizedlist></para></listitem></itemizedlist>

<F2><p> produces:

<para>

</para></para>

If this could be fixed it would really make editing a lot easier so plz look over the code and post an update :-)

Morten Damsgaard-Madsen
Denmark

Where is the linuxjournal ser

Anonymous's picture
Submitted by Anonymous (not verified) on Fri, 11/05/2004 - 16:46.

Where is the linuxjournal server that you downloaded the files from?

ftp://www.linuxjournal.com/pu

Pablo's picture
Submitted by Pablo (not verified) on Fri, 01/14/2005 - 07:25.

ftp://ftp.ssc.com/pub/lj/listings/Web/7737.tar.gz

Re: Vim Macros for Editing DocBook Documents

Anonymous's picture
Submitted by Anonymous on Sun, 09/05/2004 - 02:00.

As usual the socurce of errors is right in front of the computer ;-).

The script works as expected - I just forgot that I had the xml.vim script installed which interacts with these macros in funny ways...

Nice work!

/Morten

Re: Vim Macros for Editing DocBook Documents

Anonymous's picture
Submitted by Anonymous on Sat, 08/28/2004 - 02:00.

I use Vim 6.2 and I get the same error.

If you observe the error shown, it says that a variable is undefined.

If you look into mfuncs.vim, you will see that "etags" is defined
in a conditional statement and used anyway subsequently.
Therefore, in the cases where the conditional statement is missed,
"etags" is undefined subsequently.

The author should have a look at the code one again and post here an update.

Re: Vim Macros for Editing DocBook Documents

Anonymous's picture
Submitted by Anonymous on Fri, 08/27/2004 - 02:00.

Same goes for me: the version of vim I use is 6.3. Maybe the macros of this article are meant for an older version ?

White Paper
More Resources
Fabric-Based Computing Enables Optimized Hyperscale Data Centers

Today’s modular x86 servers are compute-centric, designed as a least common denominator to support a wide range of IT workloads. Those generic, virtualized IT workloads have much different resource optimization requirements than hyperscale and cloud applications. They have resulted in a “one size fits all” enterprise IT architecture that is not optimized for a specific set of IT workloads, and especially not emerging hyperscale workloads, such as web applications, big data, and object storage. In this report, you will learn how shifting the focus from traditional compute-centric IT architectures to an innovative disaggregated fabric-based architecture can optimize and scale your data center.

Learn More

Sponsored by AMD

White Paper
More Resources
Red Hat White Paper: Using an Open Source Framework to Catch the Bad Guy

Built-in forensics, incident response, and security with Red Hat Enterprise Linux 6

Every security policy provides guidance and requirements for ensuring adequate protection of information and data, as well as high-level technical and administrative security requirements for a system in a given environment. Traditionally, providing security for a system focuses on the confidentiality of the information on it. However, protecting the data integrity and system and data availability is just as important. For example, when processing United States intelligence information, there are three attributes that require protection: confidentiality, integrity, and availability.

Learn more about catching the bad guy in this free white paper.

Learn More

Sponsored by DLT Solutions