Changes between Version 2 and Version 3 of TracBibPlugin


Ignore:
Timestamp:
Oct 14, 2017, 7:05:10 PM (7 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • TracBibPlugin

    v2 v3  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = A !BibTex Cite Plugin
     3= Add bibliographic references to wiki pages
    44
    55== Description
    66
    7 [http://en.wikipedia.org/wiki/BibTeX BibTex] is for formatting lists of bibliographic references.
     7[wikipedia:BibTeX] is a system for formatting lists of bibliographic references.
    88
    99This plugin provides the ability to cite from common bibtex (*.bib) files.
    1010
    11 The plugin can use bibtex files out of :
    12  * a repository (svn, git, mercurial)
     11The plugin can use bibtex files out of:
     12 * a repository, such as svn, git, mercurial
    1313 * a wiki page
    14  * a Wiki-Attachment
    15  * or an external website.
     14 * a wiki attachment
     15 * an external website
    1616
    1717If a wiki page called !BibTex exists, the page is loaded automatically by //!BibRef()// and used as standard library.
    … …  
    1919Make sure to put bibtex entries into a Code Block when you use them from a wiki page.
    2020
    21 The command structure is inspired by the reference and bibtex system in latex. This should make it easy to make this plugin compatible with existing trac - latex plugins.
     21Other features:
     22 * The new default citation style is an IEEE-like style.
     23 * !BibTeX files can be loaded from external websites.
     24 * Extension point `IBibRefFormatter` for custom citation styles introduced.
     25 * Extension point `IBibSourceProvider` for custom BibTeX loaders introduced.
     26 * Wiki pages can be used as bibliograpy. The Entries must be inside a code block.
     27 * The attachments can now be loaded from any page in the wiki.
     28 * A special page "!BibTex" will be loaded automatically if this page exists, like in [t:BadContent BadContent].
     29
     30The command structure is inspired by the reference and bibtex system in LateX. This should make it easy to make this plugin compatible with existing latex plugins: tagged:LaTeX
    2231
    2332== Bugs/Feature Requests
    2433
    2534Existing bugs and feature requests for TracBibPlugin are
    26 [query:status!=closed&component=TracBibPlugin&order=priority here].
     35[report:9?COMPONENT=TracBibPlugin here].
    2736
    2837If you have any issues, create a
    29 [/newticket?component=TracBibPlugin&owner=Amfortas new ticket].
     38[/newticket?component=TracBibPlugin new ticket].
    3039
    3140[[TicketQuery(component=TracBibPlugin&group=type,format=progress)]]
    3241
    33 == Download and Source
     42== Download
    3443
    35 Download the [download:tracbibplugin zipped source], check out from [/svn/tracbibplugin using Subversion], or [source:tracbibplugin browse the source] with Trac.
     44Download the zipped source from [export:tracbibplugin here].
     45
     46== Source
     47
     48You can check out TracBibPlugin from [/svn/tracbibplugin here] using Subversion, or [source:tracbibplugin browse the source] with Trac.
    3649
    3750== Installation
    … …  
    4053
    4154Run one of the following commands, depending on the Trac version that you run:
    42 {{{
    43 #!sh
    44 easy_install http://trac-hacks.org/svn/tracbibplugin/0.10/
    45 easy_install http://trac-hacks.org/svn/tracbibplugin/0.11/
    46 easy_install http://trac-hacks.org/svn/tracbibplugin/0.12/
    47 easy_install http://trac-hacks.org/svn/tracbibplugin/1.0/
     55{{{#!sh
     56easy_install https://trac-hacks.org/svn/tracbibplugin/0.10/
     57easy_install https://trac-hacks.org/svn/tracbibplugin/0.11/
     58easy_install https://trac-hacks.org/svn/tracbibplugin/0.12/
     59easy_install https://trac-hacks.org/svn/tracbibplugin/1.0/
    4860}}}
    4961
    50 == News
     62== Configuration
    5163
    52  * The new default citation style is an IEEE-like style.
    53  * !BibTeX files can be loaded from external websites.
    54  * Extensionpoint ''IBibRefFormatter'' for custom citation styles introduced.
    55  * Extensionpoint ''IBibSourceProvider'' for custom !BibTeX loaders introduced.
    56  * Wiki pages can be used as bibliograpy. The Entries must be inside a code block.
    57  * The attachments can now be loaded fom any page in the wiki.
    58  * A special page "!BibTex" will be loaded automatically if this page exists, like in [http://trac.edgewall.org/wiki/BadContent BadContent].
    59 
    60 == Usage
    61 
    62 === Configuration Settings
    63 
    64 You can add a `[bibtext]` config section in `trac.ini`. In this section you can change the heading of the References and you can add other sources that should always be loaded:
    65 {{{
    66 #!ini
     64You can add a `[bibtext]` config section in your `trac.ini` file. In this section you can change the heading of the References and you can add other sources that should always be loaded:
     65{{{#!ini
    6766[bibtex]
    68 heading= Literatur # default: References
    69 auto= source:mybib.bib, wiki:BibTexBlub # default: wiki:BibTex
     67heading = Literatur # default: References
     68auto = source:mybib.bib, wiki:BibTexBlub # default: wiki:BibTex
    7069}}}
    7170
    … …  
    7776[[BibAdd(attachment:[wikipage/]file)]]   # add a file from a wiki attachment
    7877[[BibAdd(wiki:page)]]                    # use a wiki page
    79 [[BibAdd(http://www.external.page.com)]] # use a bibtex file from everywhere
     78[[BibAdd(http://www.external.page.com)]] # use a bibtex file from anywhere on the web
    8079}}}
    8180
    … …  
    141140[[BibAdd(source:mybib.bib)]]
    142141
    143 I am citing here [[BibCite(small)]] and someone said "hello world" [[BibCite(wiki,123)]] and
    144 cite:small:123-124 is important. finally the BibTex entry with the key ''big'' is not cited but
    145 will appear in the references because of tho ''!BibNoCite'' macro.
     142I am citing here [[BibCite(small)]] and someone said "hello world" [[BibCite(wiki,123)]] and cite:small:123-124 is important. finally the BibTex entry with the key ''big'' is not cited, but will appear in the references because of tho ''!BibNoCite'' macro.
    146143
    147144[[BibNoCite(big)]]
    … …  
    151148When rendered this looks as follows:
    152149
    153 [[Image(tracbib2.png)]]
     150[[Image(tracbib2.png, border=2)]]
    154151
    155152== Related