ardour/livetrax
13
0
Fork 0
Code
8f55ca6a50
livetrax/manual/config/dbhelper.vim

130 lines
7.1 KiB
VimL
Raw Normal View History

Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-01 23:29:55 -05:00
" Tim Mayberry's .vimrc mappings for use with DocBook 4.3. This has been
" revised from Vivek Venugopalan's .vimrc which was revised from Dan York's .vimrc
" Revised: August 23, 2006
" Used with vim 7.0
" email : mojofunk@gmail.com
" MAPPINGS
" Like the .vimrc file shown at http://www.vim.org/ I decided to
" start all my mappings with a comma. Since I do pretty much all
" my work in DocBook, I just started with the letter after the
" comma for a DB tag, rather than using something like 'd' to
" indicate it was a DB tag (i.e. ',dp' instead of ',p'). If you
" want to use other mappings, you may want to change this.
" My mappings are currently primarily for easy of entering DB
" tags. I haven't yet gotten into changing existing text with mappings.
" A side effect of using the comma for mappings is that when you type
" a comma in vim, it will now pause and wait for input. If you just hit
" the spacebar, you should see a regular old comma appear.
" Note: 'imap' = a mapping for 'insert' mode of vim
" All of these commands work ONLY when you are in Insert mode
" <CR> will put a line return in the file. This is purely my style of
" entering certain DocBook tags. You may wish to remove some.
" After typing the DocBook tag, many of these macros then switch to
" vim command mode, reposition the cursor to where I want it to be,
" and then re-inter insert mode. You may wish to change where it ends.
let mapleader = ","
" header and setup info for a book
imap<leader>dtbk <!DOCTYPE BOOK PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
imap<leader>bk <book><CR><bookinfo><CR><title></title><CR><author><CR><firstname></firstname><CR><surname></surname><CR></author><CR><address><email></email></address><CR><copyright><CR><year></year><CR><holder></holder><CR></copyright><CR><revhistory><CR></revhistory><CR></bookinfo><CR><CR></book><esc>12k$bba
"Internal subset declaration
imap<leader>et <!ENTITY TODO-key "TODO-value"><CR>
imap<leader>rev <revision><CR><revnumber></revnumber><CR><date></date><CR><authorinitials></authorinitials><CR><revremark></revremark><CR></revision><esc>4k$bba
"header and setup info for an article.
imap<leader>dtart <!DOCTYPE ARTICLE PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
imap<leader>art <article><CR><title></title><CR><CR><artheader><CR><CR><author><CR><firstname></firstname><CR><surname></surname><CR><affiliation><CR><address><email></email></address></affiliation><CR></author><CR><CR><revhistory><CR></revhistory><CR><CR></artheader><CR><abstract><CR><indexterm><CR><primary></primary><CR></indexterm><CR><para><CR><para><CR></abstract><CR><CR></article><esc>16k$bba
"Paragraph formatting
imap<leader>p <para><CR></para><esc>k$a
" character formatting
imap<leader>em <emphasis></emphasis><esc>bba
imap<leader>es <emphasis role="strong"></emphasis><esc>bbla
"Special characters
imap<leader>> &gt;
imap<leader>< &lt;
" links
imap<leader>ul <ulink url=""></ulink><esc>bb3la
imap<leader>lk <link linkend=""></link><esc>bb3la
imap<leader>x <xref linkend=""/><esc>bla
" lists
" note that '<leader>l2' was created solely to fit into<leader>il and<leader>ol
imap<leader>li <listitem><CR><para><CR></para><CR></listitem><esc>kk$a
imap<leader>l2 <listitem><CR><para><CR></para><CR></listitem>
imap<leader>il <itemizedlist><CR><leader>l2<CR></itemizedlist><esc>kkk$a
imap<leader>ol <orderedlist><CR><leader>l2<CR></orderedlist><esc>kkk$a
imap<leader>ve <varlistentry><CR><term></term><CR><leader>l2<CR></varlistentry>
imap<leader>vl <variablelist><CR><title></title><CR><leader>ve<CR></variablelist>
" sections
imap<leader>sn <section id=""><CR><title></title><CR><para><CR></para><CR></section><esc>kkkk$bla
"imap<leader>s1 <sect1 id=""><CR><title></title><CR><para><CR></para><CR></sect1><esc>kkkk$bla
"imap<leader>s2 <sect2 id=""><CR><title></title><CR><para><CR></para><CR></sect2><esc>kkkk$bla
"imap<leader>s3 <sect3 id=""><CR><title></title><CR><para><CR></para><CR></sect3><esc>kkkk$bla
imap<leader>ch <chapter id=""><CR><title></title><CR><para><CR></para><CR></chapter><esc>kkkk$bla
Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
" media related
imap<leader>fig <figure><CR><title></title><CR></figure><esc>k$bba
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-01 23:29:55 -05:00
imap<leader>img <mediaobject><CR><imageobject><CR><imagedata fileref=""/><CR></imageobject><CR></mediaobject><esc>kk$bla
Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
imap<leader>oi <objectinfo><CR></objectinfo><esc>k$a
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-01 23:29:55 -05:00
" other objects
imap<leader>ti <title></title><esc>bba
imap<leader>fo <footnote><CR><para><CR></para><CR></footnote><esc>kk$a
imap<leader>sb <sidebar><CR><title></title><CR><para></para><CR></sidebar>
imap<leader>co <!-- --><esc>bhi
imap<leader>qt <blockquote><CR><attribution></attribution><CR><literallayout><CR></literallayout><CR></blockquote>
Update dbhelper.vim to include mapping for indexterm git-svn-id: svn://localhost/ardour2/trunk@1892 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-05-22 05:50:46 -04:00
imap<leader>l <literal></literal><esc>bba
" glossary
Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
imap<leader>ge <glossentry id=""><CR><glossterm></glossterm><CR><glossdef><CR><para><CR></para><CR></glossdef><CR></glossentry><esc>6k$bla
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-01 23:29:55 -05:00
imap<leader>gt <glossterm linkend=""></glossterm><esc>bb3la
Added the BSD licensed xmlformat utility for keeping the xml pretty and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-14 06:23:38 -05:00
imap<leader>gs <glossseealso></glossseealso><esc>bba
Update dbhelper.vim to include mapping for indexterm git-svn-id: svn://localhost/ardour2/trunk@1892 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-05-22 05:50:46 -04:00
" index
imap<leader>it <indexterm><CR><primary></primary><CR></indexterm><esc>k$bba
Add mapping for secondary index term to dbhelper.vim git-svn-id: svn://localhost/ardour2/trunk@1896 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-05-22 05:53:32 -04:00
imap<leader>is <secondary></secondary><esc>bba
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-01 23:29:55 -05:00
" admonitions
imap<leader>no <note><CR><para></para><CR></note><esc>k$bba
imap<leader>tp <tip><CR><para></para><CR></tip><esc>k$bba
imap<leader>imp <important><CR><para></para><CR></important><esc>k$bba
Add mapping for warning tag to vim docbook helper. git-svn-id: svn://localhost/ardour2/trunk@1473 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-19 09:25:27 -05:00
"imap<leader>ca <caution><CR><para></para><CR></caution><esc>k$bba
imap<leader>w <warning><CR><para></para><CR></warning><esc>k$bba
Add the ardour manual converted to docbook format with only a few minor additions. Add dbhelper.vim key stroke mappings I use for working with docbook source. There are no xsl or css files for customizing the html output so it will look really boring...this will only be temporary. Support for content localization and generation of pdf's is planned. git-svn-id: svn://localhost/ardour2/trunk@1405 d708f5d6-7413-0410-9779-e7cbd77b26cf
2007-02-01 23:29:55 -05:00
" computer stuff
imap<leader>app <application></application><esc>bba
imap<leader>cm <command></command><esc>bba
imap<leader>sc <screen><CR></screen><esc>k$a
imap<leader>fn <filename></filename><esc>bba
imap<leader>gb <guibutton></guibutton><esc>bba
imap<leader>gl <guilabel></guilabel><esc>bba
imap<leader>gm <guimenuitem></guimenuitem><esc>bba
imap<leader>mb <mousebutton></mousebutton><esc>bba
imap<leader>mc <menuchoice><guimenu></guimenu><guisubmenu></guisubmenu></menuchoice><esc>8ba
imap<leader>kc <keycombo><keycap></keycap><keycap></keycap></keycombo><esc>8ba
imap<leader>kk <keycap></keycap><esc>bba
imap<leader>row <row><CR><entry><CR></entry><CR></row><esc>kk$a
imap<leader>en <entry><CR></entry><esc>k$a
" examples
imap<leader>ex <example id=""><CR><title></title><CR></example><ESC>$kkba
"For preparing FAQs
imap<leader>faq <article class=faq><CR><title>Frequently asked questions</title><CR><CR><articleinfo><CR><CR><author><CR><firstname></firstname><CR><surname></surname><CR><affiliation><CR><address><email></email></address></affiliation><CR></author><CR><CR><revhistory><CR></revhistory><CR><CR></articleinfo><CR><abstract><CR><indexterm><CR><primary></primary><CR></indexterm><CR><para><CR><para><CR></abstract><CR><CR><qandaset><CR><qandadiv><CR><title></title><CR><qandaentry><CR><question><CR><para></para><CR></question><CR><answer><CR><para></para><CR></answer><CR></qandaentry><CR><qandadiv><CR><qandaset><CR><CR></article><esc>16k$bba
imap<leader>qd <qandaset><CR><qandadiv><CR><title></title><CR><qandaentry><CR><question><CR><para></para><CR></question><CR><answer><CR><para></para><CR></answer><CR></qandaentry><CR><qandadiv><esc>9k$bba
imap<leader>qa <qandaentry><CR><question><CR><para></para><CR></question><CR><answer><CR><para></para><CR></answer><CR></qandaentry><esc>5k$bba
Copy Permalink