Vim Macros for Editing DocBook Documents

Macros for key mappings, tags and entities that can be used with DocBook/XML and other similar markup languages.
Modifying the Macros

DocBook is a vast markup language offering many tags, and most projects use only a subset of the available tags. The bindings above were developed for marking up LJ articles. Your use of DocBook probably will focus on a different set of tags, so you probably need to change the templates and key bindings.

The file tagtmps.vim contains the templates inserted by the <F2> key. Listing 2 shows the template for the article tag.

Listing 2. Article Tag Template


let g:Template_article ="<?xml version=\"1.0\" encoding=\"ISO-8859-1\" standalone=\"no\"?><CR>"
                       \."<!DOCTYPE article SYSTEM \"docbookx.dtd\"><CR><CR>"
                       \."<article><CR><CR>"
                       \."<simplesect><title/><CR>"
                       \."<para><CR>-:-<CR>"
                       \."</para><CR>"
                       \."</simplesect><CR><CR>"
                       \."<simplesect><title></title><CR>"
                       \."<para><CR>"
                       \."</para><CR>"
                       \."</simplesect><CR><CR>"
                       \."</article>"

All templates are stored in global string variables whose names start with Template_ and end with the tag to which the template corresponds. The g: prefix in the variable name makes it a global variable. Long strings can be placed on multiple lines by prefixing the second and subsequent lines with a backslash (\) and using the dot (.) concatenation operator to append the lines together. Each string piece is contained within double quotes. Double-quoted strings understand the usual C escape sequences. You can modify the existing templates or add new ones for other tags by following the described naming sequence. Within a template the sequence -:- is used to specify where you want the cursor to be placed after the template is inserted. The macro automatically removes this string after inserting the macro.

If you want to change the function keys used to execute the macros, modify the following lines in the file mfuncs.vim:


let s:InsertTagTemplateKey   = "<F2>"
let s:InsertSymbolKey        = "<F3>"
let s:InsertForeignCharKey   = "<F4>"
let s:InsertStartTagKey      = "<F5>"
let s:InsertEndTagKey        = "<F6>"
let s:TagWordKey             = "<F7>"
let s:TagRangeKey            = "<F7>"
let s:ChangeTagKey           = "<F8>"

If you want to change the tag-keys, symbol-keys or foreign-char-keys that follow the functions keys or change the tags associated with the keys, change the corresponding lines in maps.vim. For example, to change b so it is associated with the tag <book> rather than the tag <emphasis role="bold">, look for the following line in maps.vim:


call MapTagKey("b", 0, 0, "emphasis", " role=\"bold\"")

and change it to:


call MapTagKey("b", 1, 1, "book", "")

The function MapTagKey is defined in mfuncs.vim. Its prototype is:


function! MapTagKey(key, snewline, enewline, tag, stagx)

Its parameters are explained in Table 5.

Table 5. MapTagKey Parameters

ParameterDescription
keyKeystroke(s) to bind the tag key to (for example, <F2>key).
snewlineOne if the start tag should be placed on a new line, zero otherwise.
enewlineOne if the end tag should be placed on a new line, zero otherwise.
tagThe tag associated with the key.
stagxExtra attributes that should be placed in the start tag.

The function MapTagKey merely sets up and executes a number of Vim nmap and imap commands to make the appropriate key bindings. Similarily, symbol-keys and foreign-char-keys are mapped by the functions MapSymbolKey and MapForeignCharKey. These functions each take two arguments, the key and the text to insert. For example:


call MapSymbolKey("3", "&frac34;")
call MapForeignCharKey("b", "&beta;")

Near the bottom of the file maps.vim are a handful of Vim nmap commands for binding the tag manipluation and movement keys, including delete tag, change tag and move tag. All of these bindings call the functions defined in the file tfuncs.vim.


nmap <S-F8> :call DeleteTag()^M          " Delete tag at cursor.
nmap <F9> :call CursorLeftByTag()^M      " Move left by tags.
nmap <F10> :call MoveTagLeft()^M         " Move tag left of preceding word.
nmap <F11> :call MoveTagRight()^M        " Move tag right of following word.
nmap <F12> :call CursorRightByTag()^M    " Move right by tags.

nmap <S-F9> :call TightenTagLeft()^M     " Delete whitespace left of tag.
nmap <S-F10> :call InsertStringLeftOfTag(" ")^M
                                         " Insert space to the left of tag.
nmap <S-F11> :call InsertStringRightOfTag(" ")^M
                                         " Insert space to the right of tag.
nmap <S-F12> :call TightenTagRight()^M   " Delete whitespace right of tag.

If you cat this file, these lines are going to look strange, and in some editors, all the lines are going to break right after the closing parentheses in the call. If you look at it with vim, you can see that the closing parentheses are followed by ^M, a carriage return. When you cat the file, this causes part of the line to be erased. Some editors cause a line break here. These mappings work in command mode and the ^M ends the command.

______________________

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

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

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

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

ftp://www.linuxjournal.com/pu

Pablo's picture

Re: Vim Macros for Editing DocBook Documents

Anonymous's picture

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

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

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
Linux Management with Red Hat Satellite: Measuring Business Impact and ROI

Linux has become a key foundation for supporting today's rapidly growing IT environments. Linux is being used to deploy business applications and databases, trading on its reputation as a low-cost operating environment. For many IT organizations, Linux is a mainstay for deploying Web servers and has evolved from handling basic file, print, and utility workloads to running mission-critical applications and databases, physically, virtually, and in the cloud. As Linux grows in importance in terms of value to the business, managing Linux environments to high standards of service quality — availability, security, and performance — becomes an essential requirement for business success.

Learn More

Sponsored by Red Hat

White Paper
Private PaaS for the Agile Enterprise

If you already use virtualized infrastructure, you are well on your way to leveraging the power of the cloud. Virtualization offers the promise of limitless resources, but how do you manage that scalability when your DevOps team doesn’t scale? In today’s hypercompetitive markets, fast results can make a difference between leading the pack vs. obsolescence. Organizations need more benefits from cloud computing than just raw resources. They need agility, flexibility, convenience, ROI, and control.

Stackato private Platform-as-a-Service technology from ActiveState extends your private cloud infrastructure by creating a private PaaS to provide on-demand availability, flexibility, control, and ultimately, faster time-to-market for your enterprise.

Learn More

Sponsored by ActiveState