DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:bb4dw

bb4dw Plugin

Compatible with DokuWiki

  • 2024-02-06 "Kaos" unknown
  • 2023-04-04 "Jack Jackrum" yes
  • 2022-07-31 "Igor" yes
  • 2020-07-29 "Hogfather" unknown

plugin Create publication lists from Bibtex using BibtexBrowser

Last updated on
2024-01-07
Provides
Syntax
Repository
Source

Similar to publistf

Tagged with bibtex, publications

About

bb4dw is heavily inspired by the family of publistX plugins (e.g. publist, publistx, publistf, etc.), and tries to closely match their features while using a modern engine to process Bibtex entries.

For Bibtex processing, the BibBrowser library is used, which provides very fast and effective processing of entries. We intentionally use BibBrowser in library mode, avoiding using its own inbuilt HTML generator and styling. Instead, the bib2tpl templating functions are reused here, allowing users to create their own templates.

Installation

Installation is easypeasy, either:

  • search for and install the plugin using the Extension Manager, or
  • refer to Plugins on how to install plugins manually.

There are no external dependencies for the bb4dw plugin.

Examples/Usage

A typical template is of the form:

@{group@
=== @groupkey@ ===
@{entry@
  * @entrykey@ ...
@}entry@
@}group@

Where @{group@…@}group@ and @{entry@…@}entry@ are used to group entries together. For each level there is a @groupkey@ and @entrykey@ field, which respectively map to the plugin's groupby key and Bibtex key.

Syntax

Basic syntax:

[bb4dw|bibtex=TYPE:SOURCE|template=TYPE:SOURCE|extra=options]
  • required
    • bibtex for selecting the Bibtex source
    • template for selecting the template
    • TYPE is either dokuwiki (or url TODO)
    • SOURCE is the path or URL (can also be relative in case of type dokuwiki)

Special extra options:

  • key=… can be used to uniquely label for better handling of HTML ID specifying, especially useful in context of Javascript. The key value is exposed in the template as @globalkey@.

Configuration and Settings

Currently, the only plugin level configurations are:

  • enforcing caching or not (to reduce load times for the page, especially useful if your Bibtex is very large)

Development

The source code of the plugin is available at GitHub: https://github.com/hv15/bb4dw.

Changelog

Known Bugs and Issues

[this section might not be needed in case of external bug manager, or use RSS feed]

ToDo/Wish List

  • add support for url type

FAQ

If you have any questions not answered here, please open an issue in the repo.

plugin/bb4dw.txt · Last modified: 2024-01-16 07:22 by Aleksandr

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki