Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Relative & base URIs #40

Closed
rquinio1A opened this issue Oct 1, 2020 · 0 comments · Fixed by #41
Closed

Relative & base URIs #40

rquinio1A opened this issue Oct 1, 2020 · 0 comments · Fixed by #41
Assignees
@rquinio1A
Labels
enhancement New feature or request

Comments

@rquinio1A
Copy link
Member

rquinio1A commented Oct 1, 2020 •
edited
Loading

In the case where the Javadoc of a project is hosted alongside the documentation via HTML backend (for instance via a Maven site), relative URIs work well to link from the userguide to the corresponding version of the Javadoc:

org.acme=./apidocs/

But when the Asciidoctor backend is standalone (pdf, confluence page, ...), the URIs need to become absolute:

org.acme=http://myserver/myproject/apidocs/

Rather than using 2 apidocs.properties files and having some duplication, the feature would be to have a new attribute apidocs_baseuri that could be set only for the standalone backends in order to automatically prefix the relative URIs:

<apidocs_baseuri>http://myserver/myproject/</apidocs_baseuri>
@rquinio1A rquinio1A added the enhancement New feature or request label Oct 1, 2020
@rquinio1A rquinio1A self-assigned this Oct 1, 2020
rquinio1A added a commit to rquinio1A/asciidoctor-extension-apidoc that referenced this issue Oct 1, 2020
@rquinio1A
Add support for baseURL for relative URLs
e30fa28 
Fixes AmadeusITGroup#40
Add a new attribute :apidocs_baseuri:
If set, it'll be used to prefix any relative URLs matched in apidocs.properties
@rquinio1A rquinio1A mentioned this issue Oct 1, 2020
Merged
rquinio1A added a commit that referenced this issue Oct 7, 2020
@rquinio1A
Add support for baseURL for relative URLs
e93dd37 
Fixes #40
Add a new attribute :apidocs_baseuri:
If set, it'll be used to prefix any relative URLs matched in apidocs.properties
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rquinio1A rquinio1A

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add support for baseURL for relative URLs rquinio1A/asciidoctor-extension-apidoc
1 participant
@rquinio1A