docs/wiki/wiki-dokuvimki.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html>
   4 <head>
   5   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   6   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   7   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   8
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10 </head>
  11 <body>
  12
  13 <p>
  14 <em>Translations of this page are also available in the following languages:</em> <a href="wiki-dokuvimki.ru.html" class="wikilink1" title="wiki-dokuvimki.ru.html">Русский</a>
  15 </p>
  16
  17 <h1 class="sectionedit1" id="using_vim_to_edit_geda_wiki_pages">Using Vim to edit gEDA wiki pages</h1>
  18 <div class="level1">
  19
  20 <p>
  21 To easy edit gEDA wiki pages in Vim you may use <strong>DokuVimKi</strong>.
  22 </p>
  23
  24 <p>
  25 You can install DokuVimKi as follows:
  26 </p>
  27 <ol>
  28 <li class="level1"><div class="li"> Download the latest version of DokuVimKi and copy all its files into appropriate directories in <em><code>~/.vim</code></em>: <pre class="code">  git clone git://github.com/chimeric/dokuvimki.git
  29   cd dokuvimki
  30   for i in doc plugin syntax; do cp &quot;$i&quot;/* ~/.vim/&quot;$i&quot;/; done </pre>
  31 </div>
  32 </li>
  33 <li class="level1"><div class="li"> To use <strong><code>:h dokuvimki</code></strong> to open DokuVimKi help you can generate Vim help tags for it using <strong><code>:helptags ~/.vim/doc/</code></strong> in Vim.</div>
  34 </li>
  35 <li class="level1"><div class="li"> You can optionally use another dokuwiki syntax file. I use one from <a href="http://github.com/nblock/vim-dokuwiki.git" class="urlextern" title="http://github.com/nblock/vim-dokuwiki.git" rel="nofollow">http://github.com/nblock/vim-dokuwiki.git</a>.</div>
  36 </li>
  37 <li class="level1"><div class="li"> To install DokuVimKi you need to have <strong>xmlrpclib</strong> installed on your system. It has probably been already installed as part of python installation. You can check this using: <pre class="code">  locate xmlrpclib </pre>
  38
  39 <p>
  40  See <a href="https://www.dokuwiki.org/devel:xmlrpc" class="urlextern" title="https://www.dokuwiki.org/devel:xmlrpc" rel="nofollow">https://www.dokuwiki.org/devel:xmlrpc</a> for more information on this.
  41 </p>
  42 </div>
  43 </li>
  44 <li class="level1"><div class="li"> You also need to install <strong>dokuwikixmlrpc</strong>. Download and install the latest version:<pre class="code">  git clone git://github.com/chimeric/dokuwikixmlrpc
  45   cd dokuwikixmlrpc
  46   sudo python setup.py install</pre>
  47
  48 <p>
  49  See the <a href="http://docs.python.org/install/index.html" class="urlextern" title="http://docs.python.org/install/index.html" rel="nofollow">Python documentation</a> for more information about installing python modules.
  50 </p>
  51 </div>
  52 </li>
  53 <li class="level1"><div class="li"> Then to set up DokuVimKi for gEDA you need to add some strings into your <em><code>~/.vimrc</code></em> file: <pre class="code vim"><span class="kw1">let</span> g<span class="sy0">:</span>DokuVimKi_USER = <span class="st0">&quot;your_wiki_login_name&quot;</span>
  54 <span class="kw1">let</span> g<span class="sy0">:</span>DokuVimKi_PASS = <span class="st0">&quot;YOUR_WIKI_PASSWORD&quot;</span>
  55 <span class="kw1">let</span> g<span class="sy0">:</span>DokuVimKi_URL = <span class="st0">&quot;http://wiki.geda-project.org/lib/exe/xmlrpc.php&quot;</span><span class="co1">
  56 &quot; Optional settings. See ':DWhelp' for details.</span>
  57 <span class="st0">&quot;&quot;</span><span class="kw1">let</span> g<span class="sy0">:</span>DokuVimKi_INDEX_WINWIDTH = <span class="nu0">30</span>
  58 <span class="st0">&quot;&quot;</span><span class="kw1">let</span> g<span class="sy0">:</span>DokuVimKi_DEFAULT_SUM = <span class="st0">&quot;[xmlrpc dokuvimki edit]&quot;</span></pre>
  59 </div>
  60 </li>
  61 <li class="level1"><div class="li"> To invoke Vim with DokuVimKi features available you have to use: <pre class="code"> vim +DokuVimKi </pre>
  62
  63 <p>
  64  To quickly invoke this command you could add the following aliases into your <em><code>~/.bashrc</code></em> file:
  65 </p>
  66 <pre class="code bash"><span class="co0"># Vim aliases for gEDA</span>
  67 <span class="kw3">alias</span> <span class="re2">vimgeda</span>=<span class="st0">&quot;vim +DokuVimKi&quot;</span>
  68 <span class="kw3">alias</span> <span class="re2">gvimgeda</span>=<span class="st0">&quot;gvim +DokuVimKi&quot;</span></pre>
  69 </div>
  70 </li>
  71 </ol>
  72
  73 <p>
  74 That&#039;s all. Type <strong><code>gvimgeda</code></strong>, wait a bit and enjoy the online
  75 Dokuwiki editing in Vim!
  76 </p>
  77
  78
  79
  80 </div>
  81 <!-- EDIT1 SECTION "Using Vim to edit gEDA wiki pages" [110-] --></body>
  82 </html>