Added configuration for new custom bibtex support.#60
Merged
philipwindecker merged 1 commit intomasterfrom Mar 13, 2023
Merged
Conversation
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>
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. |
Contributor
Author
|
example_build_bibtex.zip |
pmai
approved these changes
Mar 13, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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