[Refdb-cvs] CVS: refdb/doc refdb-manual-chapter1.sgml,1.11,1.12 refdb-manual-chapter10.sgml,1.18,1.1
Status: Beta
Brought to you by:
mhoenicka
Menu
▾
▴
[Refdb-cvs] CVS: refdb/doc refdb-manual-chapter1.sgml,1.11,1.12 refdb-manual-chapter10.sgml,1.18,1.19 refdb-manual-chapter11.sgml,1.12,1.13 refdb-manual-chapter12.sgml,1.10,1.11 refdb-manual-chapter13.sgml,1.14,1.15 refdb-manual-chapter14.sgml,1.8,1.9 refdb-manual-chapter2.sgml,1.14,1.15 refdb-manual-chapter4.sgml,1.13,1.14 refdb-manual-chapter5.sgml,1.23,1.24 refdb-manual-chapter7.sgml,1.14,1.15 refdb-manual-chapter8.sgml,1.12,1.13
|
From: Markus H. <mho...@us...> - 2004-02-08 00:35:44
|
Update of /cvsroot/refdb/refdb/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13835 Modified Files: refdb-manual-chapter1.sgml refdb-manual-chapter10.sgml refdb-manual-chapter11.sgml refdb-manual-chapter12.sgml refdb-manual-chapter13.sgml refdb-manual-chapter14.sgml refdb-manual-chapter2.sgml refdb-manual-chapter4.sgml refdb-manual-chapter5.sgml refdb-manual-chapter7.sgml refdb-manual-chapter8.sgml Log Message: updated for 0.9.4 Index: refdb-manual-chapter1.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter1.sgml,v retrieving revision 1.11 retrieving revision 1.12 diff -u -U2 -r1.11 -r1.12 --- refdb-manual-chapter1.sgml 30 Dec 2003 23:51:36 -0000 1.11 +++ refdb-manual-chapter1.sgml 8 Feb 2004 00:32:45 -0000 1.12 @@ -70,5 +70,5 @@ </listitem> <listitem> - <para>The query language is fairly simple yet powerful. You can search in all fields in the database. You can use the Boolean operators <wordasword>AND</wordasword>, <wordasword>OR</wordasword>, <wordasword>NOT</wordasword> to combine search expressions. You can use brackets <wordasword>()</wordasword> to group search expressions. All alphanumeric fields (i.e. most except e.g. the publication year) treat the search string as a Unix-style regular expression which gives you enormous flexibility in your search strategies. The readline library reads the user input in all interactive clients. You can recall any previous search strings with a few keystrokes and re-run them or modify them as needed.</para> + <para>The query language is fairly simple yet powerful. You can search in all fields in the database. You can use the Boolean operators <wordasword>AND</wordasword>, <wordasword>OR</wordasword>, <wordasword>NOT</wordasword> to combine search expressions. You can use brackets <wordasword>()</wordasword> to group search expressions. You can use either literal matches or regular expressions in all alphanumeric fields (i.e. most except e.g. the publication year). This gives you enormous flexibility in your search strategies. The readline library reads the user input in all interactive clients. You can recall any previous search strings with a few keystrokes and re-run them or modify them as needed.</para> </listitem> <listitem> @@ -77,4 +77,7 @@ </listitem> <listitem> + <para>&appname; supports all character encodings available on your platform. While the available encodings in the database may be limited by the database engine, &appname; can convert incoming data as well as exported data with only few limitations.</para> + </listitem> + <listitem> <para>&appname; handles the AV field of the RIS input files in a very flexible way. You can specify a path to a PDF or Postscript version of the document on your harddrive or on the web. The local path can be split into a variable and a static part. The variable part can be specified on the command line e.g. if you access your data remotely via a NFS-mounted share.</para> </listitem> Index: refdb-manual-chapter10.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter10.sgml,v retrieving revision 1.18 retrieving revision 1.19 diff -u -U2 -r1.18 -r1.19 --- refdb-manual-chapter10.sgml 30 Dec 2003 23:51:36 -0000 1.18 +++ refdb-manual-chapter10.sgml 8 Feb 2004 00:32:45 -0000 1.19 @@ -34,5 +34,4 @@ <arg>-d <replaceable>database</replaceable></arg> <arg>-e <replaceable>log-destination</replaceable></arg> - <arg>-E <replaceable>encoding</replaceable></arg> <arg>-F <replaceable>fields</replaceable></arg> <arg>-g <replaceable>deffile</replaceable></arg> @@ -61,5 +60,4 @@ <arg choice="req">-d <replaceable>database</replaceable></arg> <arg>-e <replaceable>log-destination</replaceable></arg> - <arg>-E <replaceable>encoding</replaceable></arg> <arg>-F <replaceable>fields</replaceable></arg> <arg>-g <replaceable>deffile</replaceable></arg> @@ -85,5 +83,4 @@ <para>Remember that you don't have to specify all command-line options each time if you define the values in <link linkend="sect1-mystery-init-files">.&appname;crc</link>.</para> <para>Use the <option>-d</option> option to specify the database that you want to work with. In an interactive session you can also set and change the default database with the <link linkend="app-c-command-selectdb"><command>selectdb</command> command</link>.</para> - <para>The encoding specified with the <option>-E</option> option is used by the HTML output of the <link linkend="app-c-command-getref"><command moreinfo="none">getref</command></link> command.</para> <para>The <option>-F</option> option specifies the default fields that are to be displayed in a <link linkend="app-c-command-getref"><command moreinfo="none">getref</command></link> query.</para> <para>The <option>-g</option> option can be used to add some default fields to all references that are added or updated. The argument <replaceable>deffile</replaceable> is the filename of a <link linkend="sect1-ris-format">RIS file</link> containing these additional fields. &appname;c first tries the filename as is, so it should be a valid relative or absolute path. If the file is not found, &appname; looks for the file in <filename><envar>$HOME</envar>/</filename>. The command aborts if the file cannot be found.</para> @@ -132,4 +129,24 @@ </row> <row> + <entry>fromencoding</entry> + <entry>ISO-8859-1</entry> + <entry>The default encoding of RIS input data. You can use any encoding that your local libiconv implementation supports.</entry> + </row> + <row> + <entry>logdest</entry> + <entry>file</entry> + <entry>Where the log output should be written to. Use either stderr, syslog, or file. For the latter to work, the logfile variable must be set appropriately</entry> + </row> + <row> + <entry>logfile</entry> + <entry><filename moreinfo="none">/var/log/refdbc.log</filename></entry> + <entry>The full path of a custom log file.</entry> + </row> + <row> + <entry>loglevel</entry> + <entry>info</entry> + <entry>Set the level of log information that you would receive. Possible values, in order of increasing verbosity, are: emerg, alert, crit, err, warning, notice, info, debug</entry> + </row> + <row> <entry>pager</entry> <entry>stdout</entry> @@ -142,4 +159,9 @@ </row> <row> + <entry>pdfroot</entry> + <entry>(none)</entry> + <entry>This value will be used as the root of the paths to PDF or Postscript offprints that can be specified with the AV field in a RIS dataset. The path should not rely on shell expansion, e.g. use <filename>/home/me/literature/</filename> instead of <filename>~/literature/</filename>. The <link linkend="sect1-pdfroot">pdfroot</link> allows you to shorten the paths that you enter for each dataset and to maintain a certain portability if you have to move the offprints to a different directory or want to access them remotely. The html output routine will concatenate the relative path of each dataset with the pdfroot to construct the link to the offprint. Instead of a local path name you can specify an URL starting with http:// or ftp:// if your offprints are accessible through a web server or ftp server.</entry> + </row> + <row> <entry>port</entry> <entry>9734</entry> @@ -157,4 +179,9 @@ </row> <row> + <entry>toencoding</entry> + <entry>(none)</entry> + <entry>The default encoding of output data. You can use any encoding that your local libiconv implementation supports. If this value is not set, the encoding of the database will be used without conversion.</entry> + </row> + <row> <entry>username</entry> <entry>login name</entry> @@ -166,9 +193,4 @@ <entry>Set this to t if you prefer verbose error messages.</entry> </row> - <row> - <entry>pdfroot</entry> - <entry>(none)</entry> - <entry>This value will be used as the root of the paths to PDF or Postscript offprints that can be specified with the AV field in a RIS dataset. The path should not rely on shell expansion, e.g. use <filename>/home/me/literature/</filename> instead of <filename>~/literature/</filename>. The <link linkend="sect1-pdfroot">pdfroot</link> allows you to shorten the paths that you enter for each dataset and to maintain a certain portability if you have to move the offprints to a different directory or want to access them remotely. The html output routine will concatenate the relative path of each dataset with the pdfroot to construct the link to the offprint. Instead of a local path name you can specify an URL starting with http:// or ftp:// if your offprints are accessible through a web server or ftp server.</entry> - </row> </tbody> </tgroup> @@ -288,4 +310,5 @@ <command>addnote</command> <arg>-d <replaceable>database</replaceable></arg> + <arg>-E <replaceable>encoding</replaceable></arg> <arg>-h</arg> <group choice="opt" rep="norepeat"> @@ -305,4 +328,5 @@ <para>The <option>-c</option> switch allows to specify a <command>command</command>. &appname;c will open a pipe to the first program in the command and send the output to this program's stdin. The command may be any valid command that you can run in your shell, so further plumbing is perfectly legal.</para> <para>Use the <option>-d</option> option to specify the database that you want to work with if it is different from the currently selected database.</para> + <para>Select an input character encoding with the <option>-E</option> option if it is different from the default UTF-8.</para> <para>The <option>-h</option> option displays a short command syntax and description, then returns to the command prompt. </para> <para>The <option>-o</option> and <option>-O</option> switches allow to redirect the output to <filename>outfile</filename> instead of the default screen display. The two options differ in the way they handle an existing <filename>outfile</filename>. <option>-o</option> will replace the existing file, while <option>-O</option> will append to the existing file. If <filename>outfile</filename> cannot be opened with the proper permissions, the output is sent to stdout instead.</para> @@ -323,4 +347,5 @@ <command>addref</command> <arg>-d <replaceable>database</replaceable></arg> + <arg>-E <replaceable>encoding</replaceable></arg> <arg>-g <replaceable>deffile</replaceable></arg> <arg>-h</arg> @@ -343,4 +368,5 @@ <para>The <option>-c</option> switch allows to specify a <command>command</command>. &appname;c will open a pipe to the first program in the command and send the output to this program's stdin. The command may be any valid command that you can run in your shell, so further plumbing is perfectly legal. This feature may e.g. be used to filter the output with grep for the error messages, dropping all success messages. This is of course not intended to make your world look grey and dull, but to make it easier to spot the (hopefully zero or few) error messages inbetween all those success messages.</para> <para>Use the <option>-d</option> option to specify the database that you want to work with.</para> + <para>Select an input character encoding with the <option>-E</option> option if it is different from the default UTF-8. RIS datasets can use any encoding that your local libiconv supports (see <command moreinfo="none">man iconv_open</command> for a list of available encodings), except UTF-16 and UTF-32. RISX datasets carry the encoding in the processing instructions, therefore this option is ignored.</para> <para>You can use two different input file formats with this command. The default format is the <link linkend="sect1-ris-format">tagged RIS format</link>. Use <option>-t risx</option> to use XML files according to the RISX DTD as input data.</para> <para>The <option>-g</option> option can be used in conjunction with RIS data to add some default fields to all references that are added with this command. The argument <replaceable>deffile</replaceable> is the filename of a <link linkend="sect1-ris-format">RIS file</link> containing these additional fields. &appname;c first tries the filename as is, so it should be a valid relative or absolute path. If the file is not found, &appname; looks for the file in <filename><envar>$HOME</envar>/</filename>. The command aborts if the file cannot be found.</para> @@ -361,7 +387,7 @@ <simplesect> <title>Example</title> - <screen><prompt>&appname;c: </prompt><userinput>addref -U doe -g .refdbdefault.ris foo.ris</userinput></screen> + <screen><prompt>&appname;c: </prompt><userinput>addref -U doe -g .refdbdefault.ris -E ISO-8859-1 foo.ris</userinput></screen> <screen><prompt>$ </prompt><userinput>refdbc -C addref -U doe -g .refdbdefault.ris -d db1 < foo.ris</userinput></screen> - <para>These commands will add the references in <filename moreinfo="none">foo.ris</filename>. The references will be associated with the user <quote>doe</quote>. Every reference will use the specified values in <filename moreinfo="none">.refdbdefault.ris</filename> in the appropriate fields. In the first (interactive) command, the active database will be used. In the second (non-interactive) command, the database has to be specified explicitly with the <option>-d</option> option.</para> + <para>These commands will add the references in <filename moreinfo="none">foo.ris</filename>. The references will be associated with the user <quote>doe</quote>. Every reference will use the specified values in <filename moreinfo="none">.refdbdefault.ris</filename> in the appropriate fields. In the first (interactive) command, the active database will be used, and the encoding is set to ISO-8859-1, aka Latin-1. In the second (non-interactive) command, the database has to be specified explicitly with the <option>-d</option> option, and the default encoding (UTF-8) is assumed.</para> </simplesect> </sect2> @@ -605,4 +631,5 @@ <command>getnote</command> <arg>-d <replaceable>database</replaceable></arg> + <arg>-E <replaceable>encoding</replaceable></arg> <arg>-h</arg> <group choice="opt" rep="norepeat"> @@ -626,13 +653,13 @@ <para>The <option>-c</option> switch allows to specify a shell <command>command</command>. &appname;c will open a pipe to the first program in the command and send the output to this program's stdin. The command may be any valid command that you can run in your shell, so further plumbing is perfectly legal. This command is handy if you want to search potentially long fields like the content for certain strings. Searching all abstracts of a database with a normal query is slow. It is usually faster to narrow down the search using other fields as far as possible without including the content field and then use grep to find what you want.</para> <para>Use the <option>-d</option> option to specify the database that you want to work with.</para> + <para>The retrieved data will use the character encoding of the database unless you request a different encoding with the <option>-E</option> option. All encodings supported by your local libiconv installation may be specified here.</para> <para>The <option>-h</option> option displays a short command syntax and description, then returns to the command prompt. </para> <para>The <option>-o</option> and <option>-O</option> switches allow to redirect the output to <filename>outfile</filename> instead of the default screen display. The two options differ in the way they handle an existing <filename>outfile</filename>. <option>-o</option> will replace the existing file, while <option>-O</option> will append to the existing file. If <filename>outfile</filename> cannot be opened with the proper permissions, the output is sent to stdout instead.</para> <caution> - <para>Depending on your query, the getref command can generate an enormous amount of output. If you view the output with a pager, the client-server communication will stall as soon as the pager accepts no new data. If the connection times out, your query results will be incomplete. It is strongly recommended to redirect all queries which return a lot of references (rule of thumb: more than 100 for screen output, more than 50 for other output) to a file or to a pipe that can handle the amount of data.</para> + <para>Depending on your query, the getnote command can generate an enormous amount of output. If you view the output with a pager, the client-server communication will stall as soon as the pager accepts no new data. If the connection times out, your query results will be incomplete. It is strongly recommended to redirect all queries which return a lot of notes (rule of thumb: more than 100 for screen output, more than 50 for other output) to a file or to a pipe that can handle the amount of data.</para> </caution> - <para>Except for RIS and risx output which always display the full dataset, the <option>-s</option> switch allows to specify additional fields (N1, N2/AB, NX, RP, SN, AD, CY, PB, UR, U1 through U5, M1 through M3) that are not displayed by default. Use "ALL" as an argument to display all available fields. If several fields are specified, the argument has to be enclosed by single quotation marks. If applied to RIS output, you can specify <wordasword>ID</wordasword> as <replaceable>format-string</replaceable> to get only a list of ID values in RIS format for all references that match the search. This is a convenient way to generate ID lists for later operations like <link linkend="app-c-command-deleteref"><command>deleteref</command></link>.</para> <para>The <option>-S</option> switch is used to sort the output. Currently you can sort only by <wordasword>ID</wordasword> (the default) or by <wordasword>PY</wordasword> (publication year).</para> - <para>The <option>-P</option> switch limits the search to the files which are in the current user's personal reference list. If this switch is absent, the whole database will be searched.</para> - <para>The <option>-t</option> switch determines the <link linkend="sect-output-formats">type of output</link>. The default value for <replaceable>output-format</replaceable> is <wordasword>scrn</wordasword> (screen output), other possible values are <wordasword>db31</wordasword> (DocBook SGML V. 3.1), <wordasword>db31x</wordasword> (DocBook XML), <wordasword>ris</wordasword> (RIS as of Reference Manager 8.01), <wordasword>risx</wordasword> (XML according to the <link linkend="sect1-writing-risx">risx DTD</link>), <wordasword>html</wordasword> (HTML), <wordasword>xhtml</wordasword> (XHTML), and <wordasword>bibtex</wordasword> (BibTeX).</para> + <para>The <option>-P</option> switch limits the search to the notes which were added by the current user. If this switch is absent, the whole database will be searched.</para> + <para>The <option>-t</option> switch determines the <link linkend="sect-output-formats">type of output</link>. The default value for <replaceable>output-format</replaceable> is <wordasword>scrn</wordasword> (screen output), other possible values are <wordasword>xnote</wordasword> (XML according to the xnote DTD), <wordasword>html</wordasword> (HTML), and <wordasword>xhtml</wordasword>.</para> <para>The <option>-f</option> switch reads the search string from <filename>file</filename> instead of from the command line, thus allowing to save searches which will be run repeatedly.</para> <para>The syntax of the queries is described in the section <link linkend="sect1-query-language">query language</link>.</para> @@ -640,6 +667,6 @@ <simplesect> <title>Example</title> - <screen width="60" format="linespecific"><prompt>&appname;c: </prompt><userinput>getref -t db31 -o temp.sgml ":AU:='& ^Doe ^Jones' AND :KW:=circular\ dichroism"</userinput></screen> - <para>This command retrieves articles with both an author starting with <quote>Doe</quote> and an author starting with <quote>Jones</quote> that have the keyword <quote>circular dichroism</quote>. The output will be saved as DocBook SGML into the file <filename moreinfo="none">temp.sgml</filename>.</para> + <screen width="60" format="linespecific"><prompt>&appname;c: </prompt><userinput>getnote -t xnote :CK:=Miller1999</userinput></screen> + <para>This command retrieves notes which are attached to the reference with the citation key "Miller1999" and displays them in the xnote format.</para> </simplesect> </sect2> @@ -651,4 +678,5 @@ <command>getref</command> <arg>-d <replaceable>database</replaceable></arg> + <arg>-E <replaceable>encoding</replaceable></arg> <arg>-h</arg> <group choice="opt" rep="norepeat"> @@ -672,4 +700,5 @@ <para>The <option>-c</option> switch allows to specify a shell <command>command</command>. &appname;c will open a pipe to the first program in the command and send the output to this program's stdin. The command may be any valid command that you can run in your shell, so further plumbing is perfectly legal. This command is handy if you want to search potentially long fields like the abstracts for certain strings. Searching all abstracts of a database with a normal query is slow. It is usually faster to narrow down the search using other fields as far as possible without including the N2 field and then use grep to find what you want.</para> <para>Use the <option>-d</option> option to specify the database that you want to work with.</para> + <para>The retrieved data will use the character encoding of the database unless you request a different encoding with the <option>-E</option> option. All encodings supported by your local libiconv installation may be specified here. See <command moreinfo="none">man iconv_open</command> for a list of available encodings.</para> <para>The <option>-h</option> option displays a short command syntax and description, then returns to the command prompt. </para> <para>The <option>-o</option> and <option>-O</option> switches allow to redirect the output to <filename>outfile</filename> instead of the default screen display. The two options differ in the way they handle an existing <filename>outfile</filename>. <option>-o</option> will replace the existing file, while <option>-O</option> will append to the existing file. If <filename>outfile</filename> cannot be opened with the proper permissions, the output is sent to stdout instead.</para> @@ -686,6 +715,6 @@ <simplesect> <title>Example</title> - <screen width="60" format="linespecific"><prompt>&appname;c: </prompt><userinput>getref -t db31 -o temp.sgml ":AU:='& ^Doe ^Jones' AND :KW:=circular\ dichroism"</userinput></screen> - <para>This command retrieves articles with both an author starting with <quote>Doe</quote> and an author starting with <quote>Jones</quote> that have the keyword <quote>circular dichroism</quote>. The output will be saved as DocBook SGML into the file <filename moreinfo="none">temp.sgml</filename>.</para> + <screen width="60" format="linespecific"><prompt>&appname;c: </prompt><userinput>getref -t ris -o temp.sgml -E ISO-8859-15 ":AU:='& ^Doe ^Jones' AND :KW:=circular\ dichroism"</userinput></screen> + <para>This command retrieves articles with both an author starting with <quote>Doe</quote> and an author starting with <quote>Jones</quote> that have the keyword <quote>circular dichroism</quote>. The output will be saved in RIS format to the file <filename moreinfo="none">temp.sgml</filename> using the character encoding ISO-8859-15.</para> </simplesect> </sect2> @@ -849,4 +878,5 @@ <command>updatenote</command> <arg>-d <replaceable>database</replaceable></arg> + <arg>-E <replaceable>encoding</replaceable></arg> <arg>-h</arg> <group choice="opt" rep="norepeat"> @@ -880,4 +910,5 @@ <command>updateref</command> <arg>-d <replaceable>database</replaceable></arg> + <arg>-E <replaceable>encoding</replaceable></arg> <arg>-g <replaceable>deffile</replaceable></arg> <arg>-h</arg> @@ -900,5 +931,5 @@ <para>Updates the references in RIS format in <replaceable>file</replaceable> in the current database.</para> <para>This command is essentially the same as <link linkend="app-c-command-addref">addref</link>, but it uses the <wordasword>ID</wordasword> fields in the input data to update existing references with the same ID. If the ID of a reference is not existent in the database, a new entry is created, ignoring the ID specified in the RIS or risx file. Currently &appname; does not check whether the new dataset has any similarity with the old one having the same ID. If you tell &appname; to update a reference, it uses whatever you send to this end.</para> - <para>For the <option>-c</option>, <option>-g</option>, <option>-h</option>, <option>-o</option>, <option>-O</option>, <option>-U</option>, and <option>-f</option> options, please refer to the description of the <link linkend="app-c-command-addref"><command moreinfo="none">addref</command></link> command.</para> + <para>For the <option>-c</option>, <option>-E</option>, <option>-g</option>, <option>-h</option>, <option>-o</option>, <option>-O</option>, <option>-U</option>, and <option>-f</option> options, please refer to the description of the <link linkend="app-c-command-addref"><command moreinfo="none">addref</command></link> command.</para> <para>Use the <option>-P</option> switch to update only the personal information for this reference, i.e. the N1 (notes), RP (reprint status), and AV (availability) fields. This will automatically add the reference to your personal reference list. All other fields will be ignored. Combine this option with the <option>-g</option> option e.g. to quickly change the reprint status of existing references to <quote>IN FILE</quote> from <quote>NOT IN FILE</quote> or from <quote>ON REQUEST</quote>.</para> </simplesect> @@ -953,4 +984,5 @@ Number of notes: 2 Highest note ID: 2 +Encoding: ISO-8859-1 Database type: risx Server type: pgsql @@ -1076,5 +1108,5 @@ <title id="sect1.title-query-language">The query language</title> <para>The <link linkend="app-c-command-getref"><command>getref</command></link> command is probably the most heavily used command. You use it to retrieve the references that you collected and saved in the database. To find a certain article or several related articles, all you have to do is to express your query in a language that &appname; understands. The first section describes how to formulate search strings for your queries.</para> - <para>The <link linkend="app-c-command-getnote"><command>getnote</command></link> command used to locate extended notes is very similar. The specifics of this command will be described in the following section.</para> + <para>The <link linkend="app-c-command-getnote"><command>getnote</command></link> command used to locate extended notes is very similar. The specifics of this command will be described in the subsequent section.</para> <sect2 id="sect-description-reference-query-language"> <title>The reference query language</title> @@ -1087,8 +1119,8 @@ <para>Every search item has the following general form:</para> <informalexample> - <para>:XY:[=|!=|<|>]<replaceable>string</replaceable></para> + <para>:XY:[=|~|!=|!~|<|>]<replaceable>string</replaceable></para> </informalexample> <warning> - <para>The current implementation of &appname; is very picky about spaces. Please make sure that you do not insert spaces or other whitespace on either side of the operators ("=", "!=", "<", ">"). If your value should start with a space, include the value in quotation marks or protect the space with a backslash.</para> + <para>The current implementation of &appname; is very picky about spaces. Please make sure that you do not insert spaces or other whitespace on either side of the operators ("=", "~", "!=", "!~", "<", ">"). If your value should start with a space, include the value in quotation marks or protect the space with a backslash.</para> </warning> <para>The sequence ":XY:" denotes the reference data field to search in. The names are mostly taken from the RIS specification. Possible field names are:</para> @@ -1263,7 +1295,9 @@ <itemizedlist> <listitem> - <para>The alphanumerical fields are matched by (non-)equality to a regular expression. Only the operators "=" and "!=" are accepted, denoting equality and non-equality, respectively. The <replaceable>search-string</replaceable> can contain any legal characters and constructs as in standard Unix regular expressions. By default, the query matches if the search string is contained anywhere in the target string. If you need a left-match, a right-match, or a full match, use the regexp special characters "^" (match the beginning of a line) and "$" (match the end of a line) to your needs. For further information about regular expressions, see the section <link linkend="sect1-regular-expressions">regular expressions</link></para> + <para>The alphanumerical fields are matched by (non-)equality to a literal string or to a regular expression. For literal matches the operators "=" and "!=" are accepted, denoting equality and non-equality, respectively. The <replaceable>search-string</replaceable> is a plain-text string.</para> + <para>Along the same lines, "~" and "!~" denote equality and non-equality for regular expression matches. The <replaceable>search-string</replaceable> can contain any legal characters and constructs as in standard Unix regular expressions. By default, the query matches if the search string is contained anywhere in the target string. If you need a left-match, a right-match, or a full match, use the regexp special characters "^" (match the beginning of a line) and "$" (match the end of a line) to your needs. For further information about regular expressions, see the section <link linkend="sect1-regular-expressions">regular expressions</link></para> <note> <para>Some database engines, like SQLite, do not support Unix-style regular expressions. Use SQL regular expressions instead.</para> + <para>If you use regular expressions, be aware that you will have to escape characters with a special meaning if you want them to be matched literally. For further details, see the <link linkend="sect2-query-examples">examples</link> below.</para> </note> </listitem> @@ -1368,5 +1402,5 @@ <para>This section shows a few example queries to help you get familiar with the syntax. If you are not familiar with the regular expressions used here, please peruse the <link linkend="sect1-regular-expressions">regular expressions section</link>. We will not use any of the fancy switches of the <link linkend="app-c-command-getref"><command>getref</command></link> command here, so the output will always be a simple listing on the screen.</para> <note> - <para>These examples assume that your database engine performs partial matches by default. This holds true for MySQL and PostgreSQL, wherease SQLite always attempts a full match. To emulate partial matches with the latter, append a percent sign (%) after each string to match. See also the section about <link linkend="sect2-regular-expressions-sql">SQL regular expressions</link>.</para> + <para>These examples assume that your database engine supports Unix regular expressions. This holds true for MySQL and PostgreSQL, wherease SQLite uses the simpler SQL regular expressions instead.</para> </note> <para>We'll start with some easy queries. First we want to display a reference with a specific ID (25 in this example):</para> @@ -1374,29 +1408,29 @@ <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :ID:=25</userinput></screen> </informalexample> - <para>Next we want to list all references by a specific author. We'll use only the last name here. If several authors share this last name, we have to specify the initials as well, as shown in the second example. Note the use of the caret "^" which makes sure that the name actually starts with the capital M. Otherwise, a last name like "DeMillerette" would match as well.</para> + <para>Next we want to list all references by a specific author. We'll use only the last name here. If several authors share this last name, we have to specify the initials as well, as shown in the second example. In the first example we use a regular expression match, denoted by the tilde operator. This obviates the need to know the full name precisely. The second example uses a literal match instead. Note the use of the caret "^" in the first example which makes sure that the name actually starts with the capital M. Otherwise, a last name like "DeMillerette" would match as well. This trick is not required in the second example as the literal match always implies a full match.</para> <informalexample> - <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=^Miller</userinput></screen> - <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=^Miller,J.D.</userinput></screen> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:~^Miller</userinput></screen> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=Miller,J.D.</userinput></screen> </informalexample> <para>If Dr. Miller was a productive person, our previous query may have returned dozens of references. Now we try to filter out the paper or the papers that we really need. In the next example, we restrict the results to the years 1995 through 1999:</para> <informalexample> - <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=^Miller AND :PY:>1994 AND :PY:<2000</userinput></screen> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:~^Miller AND :PY:>1994 AND :PY:<2000</userinput></screen> </informalexample> <para>If this did not bring us close enough, we may try to include a coauthor:</para> <informalexample> - <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=^Miller AND :AU:=^Doe AND :PY:>1994 AND :PY:<2000</userinput></screen> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=~Miller AND :AU:~^Doe AND :PY:>1994 AND :PY:<2000</userinput></screen> </informalexample> <para>At this point we could narrow down the search by excluding other authors that often published with Dr. Miller, but are irrelevant here:</para> <informalexample> - <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=^Miller AND :AU:=^Doe AND NOT (:AU:=^Jones) AND :PY:>1994 AND :PY:<2000</userinput></screen> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:~^Miller AND :AU:~^Doe AND NOT (:AU:~^Jones) AND :PY:>1994 AND :PY:<2000</userinput></screen> </informalexample> <para>Unfortunately, this is still a venerable list of publications. Now we try to include a few keywords. This is now a pretty complex query. It will return all references by the authors Miller and Doe between 1995 and 1999 with either the keyword "blood" or the keyword "animal" or the keywords "guanyl" and "cyclase", the latter only if both are present. The truncated spelling of "guanyl" ensures that both "guanylyl" and "guanylate" (which are interchangeable) will match. The funny expressions with the angle brackets ensure that the keywords will match regardless of whether they start with a capital letter or not.</para> <informalexample> - <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:=^Miller AND :AU:=^Doe AND :PY:>1994 AND :PY:<2000 AND -(:KW:=[bB]lood OR :KW:=[aA]nimal OR (:KW:=[gG]uanyl AND :KW:=[cC]yclase))</userinput></screen> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :AU:~^Miller AND :AU:~^Doe AND :PY:>1994 AND :PY:<2000 AND +(:KW:~[bB]lood OR :KW:~[aA]nimal OR (:KW:~[gG]uanyl AND :KW:~[cC]yclase))</userinput></screen> </informalexample> - <para>And now for something completely different. If you've added a couple extended notes to your database, you can retrieve references that are attached to a specific extended note, e.g. to the note with the citation key "Miller1999":</para> + <para>And now for something completely different. If you've added a couple extended notes to your database, you can retrieve references that are attached to a specific extended note, e.g. to the note with the citation key "biochemistry1999":</para> <informalexample> - <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getnote :NCK:=biochemistry1999</userinput></screen> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :NCK:=biochemistry1999</userinput></screen> </informalexample> <para>If you want to see all notes which are attached to a reference with the citation key "Miller1999", use the following command:</para> @@ -1404,4 +1438,16 @@ <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getnote :CK:=Miller1999</userinput></screen> </informalexample> + <para>Regular expressions may have unwanted side effects at times. Consider the keyword "52-67-5 (Penicillamine)" (a chemical name as used by the <ulink url="http://ncbi.nlm.nih.gov">Pubmed</ulink> database). Doing a literal match is straightforward:</para> + <informalexample> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :KW:='52-67-5 (Penicillamine)'</userinput></screen> + </informalexample> + <para>However, if we use the same argument for a regexp match, we won't get the desired results. The parentheses have a special meaning in regular expressions. Therefore we have to escape them if we want a literal match:</para> + <informalexample> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :KW:~'\(Penicillamine\)'</userinput></screen> + </informalexample> + <para>Things are a little different again if you run a database engine that does not use Unix regular expressions, but SQL regular expressions instead. These know only '%' and '_' as special characters, and you have to escape them by doubling:</para> + <informalexample> + <screen format="linespecific"><prompt moreinfo="none">refdbc: </prompt><userinput moreinfo="none">getref :KW:~'100%%'</userinput></screen> + </informalexample> <tip> <para>Remember that if you extend or modify a previous query, you don't have to retype everything: Just use the <keycap>up arrow key</keycap> to scroll through the previous commands, or use <keycombo moreinfo="none"> @@ -1418,5 +1464,5 @@ <para>Some database engines like SQLite do not support Unix-style regular expressions. You have to use SQL regular expressions in this case.</para> </note> - <para>The difference between a search and a regular expression search is that the latter allows some <quote>fuzziness</quote> in the search string. The former requires that the search string and the search result match character by character. In simple words, regular expressions allow to search for strings which are similar to some extent, and you can exactly specify to which extent.</para> + <para>The difference between a literal match and a regular expression match is that the latter allows some <quote>fuzziness</quote> in the search string. The former requires that the search string and the search result match character by character. In simple words, regular expressions allow to search for strings which are similar to some extent, and you can exactly specify to which extent.</para> <sect2 id="sect2-regular-expressions-unix"> <title>Unix-style regular expressions</title> @@ -1529,4 +1575,5 @@ </varlistentry> </variablelist> + <para>In order to match a SQL regular expression special character literally, you have to escape it by doubling.</para> </sect2> </sect1> Index: refdb-manual-chapter11.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter11.sgml,v retrieving revision 1.12 retrieving revision 1.13 diff -u -U2 -r1.12 -r1.13 --- refdb-manual-chapter11.sgml 30 Dec 2003 23:51:37 -0000 1.12 +++ refdb-manual-chapter11.sgml 8 Feb 2004 00:32:45 -0000 1.13 @@ -66,4 +66,8 @@ </sect2> <sect2> + <title>Character encodings</title> + <para>The RIS specification has not built-in means to specify the character encoding of the data. Commercial applications apparently expect the data to be encoded as ISO-8859-1, aka Latin-1. &appname; does not have this limitation, you are free to use any encoding available on your platform (except UTF-16 and UTF-32). However, you should be aware that this may cause an interchange issue if you plan to use these data in a commercial reference management program. In any case, as the datasets do not specify their encoding, you have to use <option>-E</option> option of the <link linkend="app-c-command-getref">getref</link> command if your input data use an encoding different from the default (ISO-8859-1).</para> + </sect2> + <sect2> <title>RIS tags</title> <para>The following list shows all available tags and their use.</para> @@ -229,5 +233,5 @@ <listitem> <para>Synonym: A1. This is the name of one author of the reference. If a reference has multiple authors, each author is specified with an AU tag on a separate line. The number of authors per RIS dataset is not limited. The sequence of the authors in the authorlist will be determined from the sequence as they appear in the RIS dataset.</para> - <para><emphasis>Format:</emphasis> A string with up to 255 characters in the form: Lastname[,(F.|First)[(M.|Middle)[,Suffix]]]. First and middle names can either be abbreviated or spelled out. Some examples for valid entries:</para> + <para><emphasis>Format:</emphasis> A string with up to 255 characters in the form: Lastname[,(F.|First)[(M.|Middle)...][,Suffix]]. First and middle names can either be abbreviated or spelled out. Use periods to separate initials, and spaces to separate spelled-out first or middle names. Lastname can be a corporate name. Some examples for valid entries:</para> <itemizedlist> <listitem> @@ -568,6 +572,6 @@ <para>Either copy <filename>ris.el</filename> into a directory which is in your load-path (<filename class="directory" moreinfo="none">/usr/local/share/emacs/site-lisp</filename> is a common place for such files), or include <filename class="directory" moreinfo="none">/usr/local/share/&appname;/site-lisp</filename> in your load-path.</para> </step> - <step performance="required"> - <para>If you're a speed fanatic, byte-compile <filename moreinfo="none">ris.el</filename> with the Emacs command <command>M-x byte-compile-file <filename>path/to/ris.el</filename></command>.</para> + <step performance="optional"> + <para>If you're a speed fanatic, byte-compile <filename moreinfo="none">ris.el</filename> with the Emacs command <command>M-x byte-compile-file <filename>path/to/ris.el</filename></command>. You won't notice a difference on systems later than a 486, though.</para> </step> <step performance="required"> @@ -631,5 +635,5 @@ </varlistentry> </variablelist> - <para>If you need other formats than those listed above, you'll either have to provide your own input filter or search the web for existing filters that convert your data to one of the supported formats. A good resource is e.g. <ulink url="http://www.ecst.csuchico.edu/~jacobsd/bib/">Dana Jacob's</ulink> pages about bibliography software.</para> + <para>If you need other formats than those listed above, you'll either have to provide your own input filter or search the web for existing filters that convert your data to one of the supported formats. A decent set of filters is supplied by Chris Putnam's <ulink url="http://www.scripps.edu/~cdputnam/software/bibutils/bibutils.html">bibutils</ulink> package. Another good resource is e.g. <ulink url="http://www.ecst.csuchico.edu/~jacobsd/bib/">Dana Jacob's</ulink> pages about bibliography software.</para> </sect1> <sect1 id="sect1-writing-risx"> @@ -637,4 +641,7 @@ <para>XML documents using the <ulink url="http://refdb.sourceforge.net/dtd/risx/risx.dtd">risx DTD</ulink> are an alternative way to add datasets to &appname; databases. You can use your favourite SGML/XML editor to edit these datasets. You can also use DSSSL or XSLT scripts to transform bibliographic data available as SGML or XML documents to risx.</para> <para>This section provides a quick outline of risx datasets. For a description of all available elements and their relationships, please visit the <ulink url="http://refdb.sourceforge.net/risx/book1.html">risx documentation</ulink>.</para> + <para>As usual, start the document with the processing instructions, followed by the document type declaration. Make sure to include the character encoding if it is different from the default (UTF-8). The other encodings supported by &appname; are UTF-16, ISO-8859-1, and US-ASCII. The first line might then read:</para> + <programlisting format="linespecific"><?xml version="1.0" encoding="utf-8"?> +</programlisting> <para>The top-level element of a risx XML document is either <sgmltag>ris</sgmltag> (if the file provides multiple datasets) or <sgmltag>entry</sgmltag>, which corresponds to a single dataset. The <sgmltag>ris</sgmltag> element holds one or more <sgmltag>entry</sgmltag> elements. The <sgmltag class="attribute">type</sgmltag> attribute specifies the type of the reference. These are the same types as described above for the RIS <link linkend="ris-typetag">TY tag</link>. The <sgmltag class="attribute">id</sgmltag> and <sgmltag class="attribute">citekey</sgmltag> attributes specify a numeric ID (which will only be used if you update references) and a citation key, respectively. The latter should be all uppercase if you intend to use the references with SGML documents.</para> <para>Each <sgmltag>entry</sgmltag> element contains up to five subelements, the first three of which provide the bibliographic information proper. risx distinguishes three levels of bibliographic information. Each <sgmltag>entry</sgmltag> can specify one or more of these levels:</para> @@ -673,5 +680,8 @@ </itemizedlist> <para>Searching for notes is similar to searching for references. Notes may have keywords, keys, and a title attached to them to easily find them. In addition, you can search for notes that link to a particular reference, author, keyword, or periodical. The inverse works as well: you can search for references that are linked to particular notes.</para> - <para>Extended notes are XML documents according to the <ulink url="http://refdb.sourceforge.net/dtd/xnote/xnote.dtd">xnote DTD</ulink>. The structure of these documents is simple enough to do without a separate documentation. If you want to write several extended notes in a file, start with an <sgmltag class="element">xnoteset</sgmltag> element. Each individual extended note is kept in an <sgmltag class="element">xnote</sgmltag> element. This element carries up to four optional attributes:</para> + <para>Extended notes are XML documents according to the <ulink url="http://refdb.sourceforge.net/dtd/xnote/xnote.dtd">xnote DTD</ulink>. The structure of these documents is simple enough to do without a separate documentation. As usual, start the document with the processing instructions, followed by the document type declaration. Make sure to include the character encoding if it is different from the default (UTF-8). The other encodings supported by &appname; are UTF-16, ISO-8859-1, and US-ASCII. The first line might then read:</para> + <programlisting format="linespecific"><?xml version="1.0" encoding="utf-8"?> +</programlisting> +<para>If you want to write several extended notes in a file, start with an <sgmltag class="element">xnoteset</sgmltag> element. Each individual extended note is kept in an <sgmltag class="element">xnote</sgmltag> element. This element carries up to four optional attributes:</para> <variablelist> <varlistentry> Index: refdb-manual-chapter12.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter12.sgml,v retrieving revision 1.10 retrieving revision 1.11 diff -u -U2 -r1.10 -r1.11 --- refdb-manual-chapter12.sgml 30 Dec 2003 23:51:37 -0000 1.10 +++ refdb-manual-chapter12.sgml 8 Feb 2004 00:32:45 -0000 1.11 @@ -173,4 +173,56 @@ </itemizedlist> </sect1> + <sect1 id="sect1-character-encoding"> + <title>Character encoding issues</title> + <para>The 7-bit ASCII character set originally employed by PC computers in the days of yore turned out to be insufficient for languages other than English. Reference data may require characters not included in the ASCII character set. The string sorting order may also follow different rules. &appname; supports national character sets as well as Unicode, which is sort of a superset of all national character sets. As a &appname; user and administrator you'll have to deal with character encoding issues at different levels.</para> + <sect2> + <title>Character encodings of databases</title> + <para>While it is possible to convert the data during import and export (see the following sections), it is still worthwile to spend a few thoughts about the character encoding used by your reference databases. If possible, use an encoding that ensures a suitable string sorting order for your data. Choosing a proper encoding also avoids unnecessary character encoding conversions when importing or exporting data.</para> + <para>The available encodings are limited by your database engine:</para> + <variablelist> + <varlistentry> + <term>SQLite</term> + <listitem> + <para>SQLite currently supports only ISO-8859-1 (the default) and UTF-8 as a compile-time option. If you install a binary package, it most likely uses ISO-8859-1.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>MySQL</term> + <listitem> + <para>This database engine supports a fairly large number of encodings, but versions prior to 4.1 allow only one encoding per server instance. That is, all databases have to use the same character encoding. Please see the <ulink url="http://www.mysql.org">MySQL documentation</ulink> for the growing list of supported encodings</para> + </listitem> + </varlistentry> + <varlistentry> + <term>PostgreSQL</term> + <listitem> + <para>This database engine supports a variety of encodings as a per-database option. That is, all reference databases may use different encodings. Please see the <ulink url="http://www.postgresql.org">PostgreSQL documentation</ulink> for a current list of supported encodings.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + <sect2> + <title>Character encodings of imported data</title> + <para>We'll have to distinguish two different sorts of data:</para> + <variablelist> + <varlistentry> + <term>RIS</term> + <listitem> + <para>This plain-text format does not have a built-in way to declare the character encoding of the data. Instead you have to use the <option>-E</option> option of the <link linkend="app-c-command-addref">addref</link> and <link linkend="app-c-command-updateref">updateref</link> commands to specify the encoding if it is different from the default (ISO-8859-1).</para> + <para>Please note that the import filters <link linkend="sect-medtorispl">med2ris.pl</link>, <link linkend="sect-entorispl">en2ris.pl</link>, and to a limited extent also <link linkend="sect-marctoris">marc2ris.pl</link> support on-the-fly character encoding conversion.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>risx and xnote</term> + <listitem> + <para>These are XML formats that can use the XML way of declaring the encoding. This is done in the processing instructions, which is the first line in a XML file. Due to a limitation of the parser used for importing XML data, only four encodings are accepted by &appname;: UTF-8, UTF-16, ISO-8859-1, US-ASCII. If your data use a different encoding, use the <command moreinfo="none">iconv</command> command line utility (usually a part of the libiconv package) to convert your data to one of the accepted encodings.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + <sect2> + <title>Character encodings of exported data</title> + <para>By default, data are exported without a character conversion, i.e. the data will use whatever encoding the database uses. If you want the exported data in a different format, request the encoding with the <option>-E</option> option. This option is accepted by the <link linkend="app-c-command-getref">getref</link> and <link linkend="app-c-command-getnote">getnote</link> commands of &appname;c as well as by the <link linkend="chapter-refdbib">&appname;ib</link> client. You may request any encoding that your local libiconv installation supports. <command moreinfo="none">man 3 iconv</command> or <command moreinfo="none">man iconv_open</command> should give a clue which encodings are available.</para> + </sect2> + </sect1> <sect1 id="sect1-pdfroot"> <title>Use pdfroot</title> Index: refdb-manual-chapter13.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter13.sgml,v retrieving revision 1.14 retrieving revision 1.15 diff -u -U2 -r1.14 -r1.15 --- refdb-manual-chapter13.sgml 30 Dec 2003 23:51:37 -0000 1.14 +++ refdb-manual-chapter13.sgml 8 Feb 2004 00:32:45 -0000 1.15 @@ -22,4 +22,5 @@ <arg choice="opt">-D <replaceable>stylespec-directory</replaceable></arg> <arg choice="opt">-e <replaceable>log destination</replaceable></arg> + <arg choice="opt">-E <replaceable>encoding</replaceable></arg> <arg choice="opt" rep="norepeat">-f <replaceable>stdin</replaceable></arg> <arg>-h</arg> @@ -44,4 +45,5 @@ <para>Use the <option>-d</option> option to specify the database that you want to work with. This will be the default database for all references unless the input file explicitly states the database for some or all citations.</para> <para>&appname;ib will create a style specification file for the subsequent transformation of your document with each run, unless you use the <option>-n</option> switch. These files will be stored in the directory that you specify with the <option>-D</option> option. Specify either a full path or "." to use the current working directory. The latter case is what you usually want if you run &appname;ib from the directory where your LaTeX or SMGL/XML document is stored. This is also the default if you do not specify a directory at all.</para> + <para>Use the <option>-E</option> option to select a useful output character encoding. If this option is not used, the bibliography data will use the character encoding of the database. See <command moreinfo="none">man iconv_open</command> for a list of available encodings.</para> <para>The <option>-f stdin</option> option is a crutch to make reading data from stdin possible on platforms that do not allow automatic detection of data on stdin, like Windows/Cygwin. On other platforms, &appname;ib automatically reads data from stdin if data are available.</para> <para>The <option>-n</option> option instructs &appname;ib not to create style specification files. Use this option if you are sure that a current style specification file already exists. This saves about as much computing time as you need to key in this option.</para> @@ -50,5 +52,5 @@ <para>The <option>-t</option> option selects the type of output. Use "db31" to generate DocBook SGML bibliographies, "db31x" for DocBook XML bibliographies, "teix" for TEI XML bibliographies, and "bibtex" for BibTeX bibliographies. The type of output also determines the type of style specification file, if any, that will be generated in addition to the bibliography for formatting purposes. This is only a matter of concern if you want to process a DocBook XML document with the DSSSL stylesheets: In this case you should use "db31" with this option. The SGML bibliography element is also a valid XML element, but you will get a DSSSL driver file instead of a XSL driver file when you use "db31x".</para> <note> - <para>In the current implementation, the <option>-t teix</option> option will also return a DocBook bibliography which needs to be transformed to a TEI bibliography with the <link linkend="sect-bibdb2tei"><filename>bibdb2tei.dsl</filename></link> DSSSL stylesheet.</para> + <para>In the current implementation, the <option>-t teix</option> option will also return a DocBook bibliography which needs to be transformed to a TEI bibliography with the <link linkend="sect-bibdb2tei"><filename>bibdb2tei.xsl</filename></link> DSSSL stylesheet.</para> </note> <para>The purpose of all other command-line switches is explained in the section <link linkend="sect1-common-command-line-options">common command-line options</link>.</para> @@ -166,4 +168,9 @@ <entry>The number where the reference numbering starts at. This option is mostly useful for compiling advanced bibliographies or for C boneheads who insist that counting starts at zero.</entry> </row> + <row> + <entry>encoding</entry> + <entry>(the database encoding)</entry> + <entry>The character encoding for the bibliography output. If this is not specified, the data will use the same encoding as the database.</entry> + </row> </tbody> </tgroup> Index: refdb-manual-chapter14.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter14.sgml,v retrieving revision 1.8 retrieving revision 1.9 diff -u -U2 -r1.8 -r1.9 --- refdb-manual-chapter14.sgml 30 Dec 2003 23:51:37 -0000 1.8 +++ refdb-manual-chapter14.sgml 8 Feb 2004 00:32:45 -0000 1.9 @@ -12,4 +12,5 @@ <title>The &appname;nd shell script</title> <para>This script should be the first choice for novices to create new SGML or XML documents for use with &appname;. If called without arguments, the script runs in an interactive mode and collects a few answers about the new document. Based on these answers it will create a skeleton document and a custom-tailored Makefile that performs all necessary steps to create formatted output from the document.</para> + <para>Alternatively you can call this script from a directory that contains an existing SGML or XML file. Pass the full name to the script when it asks for a filename, and the script will try to guess some of the settings from the existing file.</para> <para>The script can create the following document types:</para> <itemizedlist> @@ -223,5 +224,5 @@ <term>-s <replaceable>stylesheet</replaceable></term> <listitem> - <para>This selects the stylesheet driver file. This file is generated by &appname;bib (which in turn is called by runbib) and contains additional formatting information.</para> + <para>This selects the stylesheet driver file. This file is generated by &appname;ib (which in turn is called by runbib) and contains additional formatting information.</para> </listitem> </varlistentry> @@ -295,8 +296,8 @@ </sect1> <sect1> - <title id="sect-bibdb2tei">The bibdb2tei.dsl stylesheet</title> - <para>This DSSSL stylesheet transforms a DocBook bibliography as g... [truncated message content] |
