asam-ev / asam-project-guide

(WIP!) Project Guide for ASAM OpenX standards
Mozilla Public License 2.0
2 stars 0 forks source link

Create custom bibliography features based on osc2 solution #156

Open philipwindecker opened 2 years ago

philipwindecker commented 2 years ago

The idea is to create a custom bibliography feature for Antora that uses the approach chosen in the osc2 project.

The osc2 approach works as follows:

  1. Have a partial named "bibliography" that defines two attributes for each bibliography entry: 1) the entry anchor and label, 2) the link to the entry
  2. Have a central attribute :bib: set with the page-id of the bibliography partial to make including that partial on every relevant page easier.
  3. Have a page named "bibliography" that uses said partial for the anchors and defines each bibliography entry as bullet point with name/link to source, author, date, and other optional information.

The idea for this extension is to only have one central bibliography.adoc page. This page contains each entry and creates links to them automatically. Ideally, this link looks similar to the bibtex approach.

philipwindecker commented 2 years ago

For reference, see https://code.asam.net/simulation/standard/openscenario-2.0/-/blob/master/standard/modules/ROOT/pages/bibliography.adoc and https://code.asam.net/simulation/standard/openscenario-2.0/-/blob/master/standard/modules/ROOT/partials/bibliography/bibliography.adoc