Skip to content

Added configuration for new custom bibtex support.#60

Merged
philipwindecker merged 1 commit intomasterfrom
antora/add_bibtex_setup
Mar 13, 2023
Merged

Added configuration for new custom bibtex support.#60
philipwindecker merged 1 commit intomasterfrom
antora/add_bibtex_setup

Conversation

@philipwindecker
Copy link
Copy Markdown
Contributor

@philipwindecker philipwindecker commented Jan 13, 2023

This adds the necessary configuration to the antora.yml so that the custom ASAM bibtex extension for Antora can generate and link to the bibliography entries correctly. Note: This also requires a setup change in the generator which is pushed separately.

Signed-off-by: Philip Windecker philip.windecker@avenyr.de

Reference to a related issue in the repository

There is no issue here but in the internal ASAM GitLab.

Add a description

Antora does not support bibtex. The bibtex solution for Asciidoctor was developed in Ruby and is not compatible with Antora (which is JavaScript). Additionally, the Asciidoctor solution expects all content to be within the same file. However, Antora distributes content over multiple separate pages which Asciidoctor (used by Antora to generate each page) does not know about.
Therefore, the existing solution cannot be used.

ASAM has developed its own rudimentary solution for Antora that supports a limited set of features from bibtex (those that were used previously in ASAM Simulation domain projects such as this). This solution specifically works with Antora and distributed pages while still utilizing the available bibtex file, thus keeping everything compatible with Asciidoctor.

To activate this extension, however, the project must add a bit of configuration to its setup, mainly the site.yml (activating the extension itself) and the relevant antora.yml (setting the location of the bibliography file).

This PR deals with the latter while the former has been changed directly in generator repository.

Mention a member

@pmai

Check the checklist

  • I have performed a self-review of my own code/documentation.
  • My documentation changes are related to another repository in the organization. Here is the link to the issue/repo.
  • My changes generate no new warnings during the documentation generation.
  • The existing travis ci which pushes the documentation to gh-pages passes with my changes.

This adds the necessary configuration to the antora.yml
so that the custom ASAM bibtex extension for Antora can
generate and link to the bibliography entries correctly.
Note: This also requires a setup change in the generator
which is pushed separately.

Signed-off-by: Philip Windecker <philip.windecker@avenyr.de>
@philipwindecker
Copy link
Copy Markdown
Contributor Author

Note: Due to the distributed nature of Antora, this change may not reflect correctly in the CI build before merging (because it builds this branch but uses the master branches from the other two content repositories). However, the links from within this repo to the bibliography should still work as they are both located within the same branch anyway.

@philipwindecker philipwindecker requested a review from pmai January 16, 2023 09:11
@philipwindecker philipwindecker marked this pull request as ready for review January 16, 2023 09:11
@philipwindecker
Copy link
Copy Markdown
Contributor Author

example_build_bibtex.zip
Locally built example with the bibtex content rendering.

@philipwindecker philipwindecker added the quality Quality improvements. label Mar 13, 2023
@philipwindecker philipwindecker merged commit 005c949 into master Mar 13, 2023
@philipwindecker philipwindecker deleted the antora/add_bibtex_setup branch March 13, 2023 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

quality Quality improvements.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants