%BIBTEX{select="author:'Moresi'"}%you get simulated:
%STARTBIBTEX{abstracts="on" keywords="on"}% @Article{DeLange:EPODD-6-3-241, author = "Rudi W. De Lange and Hendry L. Esterhuizen and Derek Beatty", title = "Performance differences between {Times} and {Helvetica} in a reading task", journal = "Electronic Pub\-lish\-ing\emdash{}Orig\-i\-na\-tion, Dissemination, and Design", volume = "6", number = "3", pages = "241--248", month = sep, year = "1993", CODEN = "EPODEU", ISSN = "0894-3982", bibdate = "Sat Jan 06 18:28:52 1996", abstract = "Typographers and printers often regard seriffed or roman typefaces as more legible and appropriate for reading material than typefaces without serifs. Authors contend that readers prefer roman above sans serif, that it is read faster, and that the comprehension rate is possibly higher when text is set in a roman typeface. The absence of satisfactory empirical data to prove these assumptions, and the importance of legibility in academic reading material, motivated this study. The aim of the study was to determine the comparative legibility of sans serif and roman typefaces. Four hundred and fifty primary school subjects from nine different schools were used in a control group pre-test, post-test research design where four different experiments were completed. Romans and sans serifs were found to be equally legible, as no significant statistical difference was found between the reading speed, scanning speed, accuracy and comprehension at the 0.05 level. These results are in contrast to the assumption that romans are more legible than sans serifs. They can be interpreted as promising for graphic designers and typographers, as it appears that legibility will not necessarily be sacrificed when certain reading material is set in a sans serif typeface.", keywords = "Legibility, Sans serif typeface, Roman typeface, Reading task, Times Roman, Helvetica", annote = "Never thought there is a difference", } %STOPBIBTEX%you get simulated:
%CITE{BahrSimpson02}%you get (simulated) (if installed) %CITE{BahrSimpson02}% The text within the citation is dictated by the results of the
%BIBTEXREF%
declaration in the topic (see below).
Note: The %CITE%
macro is also defined by the Foswiki:Extensions.BibliographyPlugin. If both plugins are installed, one must use the alternate declaration, %BIBCITE{...}%
, to access the BibtexPlugin functionality.
%BIBTEX{<attributes>}%
- render a set of bibtex files attached to some topic
%STARTBIBTEX{<attributes>}% ... %STOPBIBTEX%
- render an inline-bibtex database
%CITE{key}%
(or %BIBCITE{key}%
) - generate an hyperlink to a bibtex entry
%BIBTEXREF{key, topic}%
- generate a list of references based on the declared CITE
keys
%BIBTEX%
and %STARTBIBTEX%
are optional. The attributes topic
and bibfile
are not valid in the %STARBIBTEX%
tag as the bibtex database is given inline and not as an attachment.
%CITE%
has one obligatory attribute, that is key
refering to the bibtex entry that is to be
cited. topic
is optional here and defaults to the recently used bibtex database location in a %BIBTEX%
tag on the same topic (see Tips).
option | value | description |
---|---|---|
topic | (webName.)topicName |
a valid topic where bibtex files are attached. |
file | bibfile |
a regular expression specifying one or more bibtex files attached to webName.topicName , must have the extension .bib if no bibfile is specified all bibfiles attached are used |
select | query |
see chapter The Query Language for an explamation |
sort | sorting |
how to sort the bibentries; possible values are year (default), author and none |
bibstyle | bibstyle |
can be one of the installed BibTeX styles installed on the servers system plus the special styles bibtool and raw :
|
rev | on , off |
reverse or normal sorting (default on ) |
mix | on , off |
switch on/off formatting of html and raw bibtex entries mixed (default off ) |
errors | on , off |
display standard errors generated by the rendering pipeline tools (e.g. warnings about double entries) in multiple bibfiles |
abstract | on , off |
switch on/off rendering the abstract-field if present in the entries (default off ) |
keywords | on , off |
switch on/off rendering the keywords-field if present in the entries (default off ) |
form | on , off , only , (formWeb.)formTopic |
delcare which query form to use, if any:
|
%CITE{key}%
declarations through out, the use of %BIBTEXREF{...}%
will generate a list of references based on the citations declared. The output of the reference list is dictated by BibTeX. Thus, the HTML output can use all of the flexibility of bibtex, including custom bibtex style templates and string macros.
The citation keys must refer to the output key produced by this plugin, which may differ from the entries in the associated .bib files according to the bibtool resource file in use. Simply use the output key produced by BibtexPlugin search template query results.
Again, if both the Foswiki:Extensions.BibliographyPlugin and Foswiki:BibtexPlugin are installed, one must use %BIBCITE{...}%
inplace of %CITE%
for the BibtexPlugin functionality to work.
%BIBTEXREF{bibstyle="alpha"}%you get simulated:
query
).
A query is a boolean expression that is evaluated against a BibTeX entry to decide whether this entry should be selected. A query is either: , <, >, <
, >= and <>
. | matches any character except newline |
[..] | character set; ranges are denoted with -, as in [a-z]; an initial ^, as in [^0-9], complements the set |
matches the beginning of the string matched | |
$ | matches the end of the string matched |
\b | matches word boundaries |
\ | quotes special characters |
regexp* | matches regexp zero, one or several times |
regexp+ | matches regexp one or several times |
regexp? | matches regexp once or not at all |
regexp1 \Ι regexp2 | alternative between two regular expressions, this operator has low priority against *, + and ? |
\( regexp \) | grouping regular expression |
form
attribute of the %BIBTEX%
command
class | description |
---|---|
bibtex | division (<div...>) surrounding the complete bibtex. The entries are rendered using a definition list: <dl> ... <dt> keyA </dt> <dd> entry </dd> ... </dl> |
bibabstract | division surrounding the abstract |
bibcomment | division surrounding the comment |
bibkeywords | division surrounding the keywords |
bibsearch | class of the table in the BibtexSearchTemplate |
biboptions | class of the options table in the BibtexSearchTemplate |
%BIBTEX{form="only"}%in a topic to which .bib files are attached. The resulting rendered form (defined by DEFAULTSEARCHTEMPLATE above) can then be used to query the .bib files.
bibtoolrcs
file yourself.
%BIBTEX%
DEFAULTWEB.DEFAULTTOPIC
in the DEFAULTSTYLE
with the DEFAULTSORT
.
%BIBTEX{web="Sandbox" topic="BibTest" file="cite.bib" select="author : 'Einstein'"}%
%BIBTEX{file="cite.bib" select="author : 'Einstein|Fermi' and year=2003"}%
DEFAULTWEB
under the topic DEFAULTTOPIC
as the BibTeX file
DEFAULTSTYLE
%CITE{keyA}%
... %CITE{keyZ}%
refering to the same database is achievable in several ways: DEFAULTTOPIC
in the Global Settings section to that topic, or
%CITE%
tag: %CITE{"keyA" topic="Main.BibtexDatabase"}%
, or
%BIBTEX{topic="BibtexDatabase" display="off"}%
, or
%CITE%
tag (not seriously)
%BIBTEX{...bibstyle="raw"...}%
commands inside a %STARBIBTEX% ... %STOPBIBTEX%
section.
%STARTBIBTEX% %BIBTEX{select="author:'YourName'" bibstyle="raw"}% @Misc{YourName02Slides, crossref = {YourName02}, note = {slides of oral presentation}, } %STOPBIBTEX%
<style type="text/css"> .bibtex { background:transparent; border:0px; } .bibtex dd { margin-left:30px; margin-right:30px; } </style>
configure
, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.
Test if the installation was successful: See if above examples work
If access control is managed at the web-server level, be sure to add
bibsearch
to the authorization list. E.g., for Apache, add the following
lines to the .htaccess
or Apache conf
file:
<Files "bibsearch"> require valid-user </Files>
Plugin Author: | Foswiki:Main/MichaelDaum, Foswiki:Main/ScottHoge |
License: | GPL (GNU General Public License) |
Version: | 14947 (2012-06-01) |
Release: | 2.2.1 |
Change History: | |
01 Jun 2012: | (v.2.2.1) Fix Foswiki:Tasks.Item11919 Workaround for MacOSX fails on other platforms. |
18 May 2012: | (v.2.2.0) added Configure setting to specify the tmp directory. |
12 May 2012: | (v2.1) various bug fixes; path settings moved to Configure; made available on foswiki.org |
14 Jan 2009: | (v2.0) ported to Foswiki |
31 Jan 2008: | (v1.5) updated to operate with TWiki 4.2 |
02 Dec 2006: | minor bug fix: removed space requirement of render path |
29 Aug 2006: | (v1.4) minor bug fixes: bibstyle replaces style , CITE/BIBCITE cleanup |
19 May 2006: | (v1.3) twiki.org release |
06 Jan 2006: | added code to generate automatic reference lists, based on declared citations |
09 Dec 2005: | reworked to use the TWiki:DakarContrib on Cairo and Beijing |
26 Nov 2004: | added simple and expert search forms, added select option to cgi-script; added configurable default search template |
25 Nov 2004: | allow inline databases to be queried also, added forgotten bibsearch cgi-script |
01 Oct 2004: | added cascading style sheets |
16 Sep 2004: | added tar ball |
16 Oct 2003: | renamed to BibtexPlugin, formerly known as EmbedBibPlugin |
16 Okt 2003: | Initial version |
CPAN Dependencies: | none |
Other Dependencies: | BibTool, Bibtex2html |
Perl Version: | >=5.6.1 |
Plugin Home: | Foswiki:Extensions/BibtexPlugin |
Support: | Foswiki:Support/BibtexPlugin |
11 Nov 2024 - 07:44 | Foswiki v2.0.2 |