[Refdb-cvs] CVS: homepage addons.html,1.2,1.3
Status: Beta
Brought to you by:
mhoenicka
Menu
▾
▴
[Refdb-cvs] CVS: homepage addons.html,1.2,1.3
|
From: Markus H. <mho...@us...> - 2005-05-09 19:23:30
|
Update of /cvsroot/refdb/homepage In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29835 Modified Files: addons.html Log Message: minor fixes by David; shortened ris-mode entry Index: addons.html =================================================================== RCS file: /cvsroot/refdb/homepage/addons.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -U2 -r1.2 -r1.3 --- addons.html 8 May 2005 21:41:23 -0000 1.2 +++ addons.html 9 May 2005 19:22:58 -0000 1.3 @@ -141,12 +141,12 @@ <h2 id="ris-mode">Emacs ris-mode</h2> <p>Author: Markus Hoenicka <mho...@us...></p> - <p>If your editor of choice should be <a href="http://directory.fsf.org/emacs.html">Emacs</a> or <a href="http://www.xemacs.org/">XEmacs</a>, the RIS major mode (ris.el) will make editing RIS datasets a little bit more comfortable.</p> + <p>If your editor of choice should be <a href="http://directory.fsf.org/emacs.html">Emacs</a> or <a href="http://www.xemacs.org/">XEmacs</a>, the RIS major mode (ris.el) will make editing RIS datasets a little bit more comfortable. Font-locking will help you to spot syntax errors. Especially the end tag (ER - ) is prone to lack the trailing space if you're not careful. The ris-mode displays valid tags in blue, except the special type (TY - ) and end (ER - ) tags which are shown in red. The tag contents are colored according to several criteria. If the contents of a field is limited in length, the color will extend only up to that limit. Author/editor, publication date, and reprint fields are checked for a valid content. ris-mode also provides the following commands:</p> + <ul> - <li>Font-locking will help you to spot syntax errors. Especially the end tag (ER - ) is prone to lack the trailing space if you're not careful. The ris-mode displays valid tags in blue, except the special type (TY - ) and end (ER - ) tags which are shown in red. The tag contents are colored according to several criteria. If the contents of a field is limited in length, the color will extend only up to that limit. Author/editor, publication date, and reprint fields are checked for a valid content.</li> - <li>ris-mode provides three commands to insert datasets ("references") and individual tags as described shortly. All of these commands have in common that they always start a new line after the current line if the cursor is not at the start of a line. Thus you can run these commands from any position of the current line and still get something that makes sense as a RIS dataset.</li> - <li>Run the command <code>insert-set</code> (C-c-C-s) to insert a new skeleton dataset (a "reference"). The function will prompt you to enter the publication type. You can use either the auto-completion feature of the minibuffer to enter a valid type or the history feature to select a previously entered type. The function will create a newline, a type tag with the type you selected, default sets of tags for a selected range of types, as well as an end tag.</li> - <li>You can insert a new tag at the beginning of a line with the command <code>insert-tag</code> which is bound to C-c-C-t. Use either the auto-completion feature of the minibuffer to enter a valid tag or the history feature to select a previously entered tag.</li> - <li>You can insert a new line below the current line with the same tag as the current line with the command <code>duplicate-tag</code>. This is bound to M-RET. This command is convenient if you add multiple keywords or authors, each of which have to go on separate tag lines.</li> - <li>You can move between RIS datasets with the commands <code>backward-set</code> (C-x[) and <code>forward-set</code> (C-x]). You can narrow the buffer to the current RIS set with the command <code>narrow-to-set</code> (C-xns). To widen to the full buffer contents again you'd use C-xnw as usual.</li> + <li><b><code>insert-set</code> (C-c-C-s):</b> inserts a new skeleton dataset (a "reference"). The function will prompt you to enter the publication type. You can use either the auto-completion feature of the minibuffer to enter a valid type or the history feature to select a previously entered type. The function will create a newline, a type tag with the type you selected, default sets of tags for a selected range of types, as well as an end tag.</li> + <li><b><code>insert-tag</code> ( C-c-C-t):</b> insert a new tag. Use either the auto-completion feature of the minibuffer to enter a valid tag or the history feature to select a previously entered tag.</li> + <li><b><code>duplicate-tag</code> (M-RET):</b> insert a new line below the current line with the same tag as the current line. This command is convenient if you add multiple keywords or authors, each of which have to go on separate tag lines.</li> + <li><b><code>backward-set</code> (C-x[) and <code>forward-set</code> (C-x]):</b> move between RIS datasets.</li> + <li><b><code>narrow-to-set</code> (C-xns) and <code>widen</code> (C-xnw):</b> narrow the buffer to the current RIS set and widen to the full buffer contents.</li> </ul> @@ -180,22 +180,25 @@ </ul> - <p>What the syntax file does <b>not</b> currently do is:</p> - <ul> - <li>check the length of the 'otherinfo' component of a date field</li> - <li>handle line continuations ('/$') -- it assumes all fields are a single line</li> - </ul> + <p>What the syntax file does <b>not</b> currently do is handle line continuations ('/$') -- it assumes all fields are a single line</p> - <p>The plugin file supplies four convenience commands mapped to keyboard shortcuts:</p> + <p>The plugin file supplies five convenience commands mapped to keyboard shortcuts:</p> <ul> <li>\a = insert RIS tag (select from menu)</li> <li>\p = insert publication type (select from menu)</li> + <li>\r = insert reprint status</li> <li>\d = duplicate current/previous tag</li> <li>\t = add reference template (group of blank tags; choose from three templates: journal|book|other)</li> </ul> + <p>Plugin limitations:</p> + <ul> + <li>The plugin relies on the shell's in-built <u>select</u> command to handle menu selection for RIS field tags publication types. All bash-like shells have this feature.</li> + <li>Vim versions compiled with a GUI (e.g., some versions of GVim) may not handle menu selection properly.</li> + </ul> + <p>To install these files on your system, follow the instructions in the archive. <a href="addons/vimhelper-1.0.tar.gz">Download vimhelper.tar.gz (1.0)</a></p> <p class="legend"><a href="vim.png"><img alt="Vim editing RIS" src="vim-small.jpg"/></a></p> - <p class="legend"><strong>Fig. 3:</strong> Vim editing RIS. Click on the image to see a <a href="vim.png">larger version</a>. The image shows how Vim spots a few of the common syntax errors: (1) the second author uses a space after the comma, (2) the publication date lacks the mandatory slashes, and (3) the end tag lacks the trailing space.</p> + <p class="legend"><strong>Fig. 3:</strong> Vim editing RIS. Click on the image to see a <a href="vim.png">larger version</a>. The image shows how Vim spots a few common syntax errors: (1) the second author uses a space after the comma, (2) the publication date lacks the mandatory slashes, and (3) the end tag lacks the trailing space.</p> <h2 id="makestyle">Makestyle (bibliography style generator)</h2> |
