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.

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

How to supply custom texts (introduction/description) through command line? #612

Closed
psiotwo opened this issue Aug 9, 2023 · 6 comments · Fixed by #619
Closed

How to supply custom texts (introduction/description) through command line? #612

psiotwo opened this issue Aug 9, 2023 · 6 comments · Fixed by #619
Assignees
Labels
new feature request for supporting a new feature pressing Will fix issue in next release
Milestone

Comments

@psiotwo
Copy link
Contributor

psiotwo commented Aug 9, 2023

I would like to automate generation of WIDOCO documentation through command line and supply the texts using the language property files, e.g. en.properties, but I am not sure, how to supply this file to the CLI. I can see an option to put it on classpath into a /widoco/en.properties file using the key introPlaceHolder. But trying 'java -cp .:widoco.jar' does not seem to work (probably due to the ClassLoader that is used for loading the resource file). The only other (ugly) option would be to unpackage/modify/repackage the JAR file.

I hope I am missing some elegant solution - thanks for any hint.

@dgarijo dgarijo added the new feature request for supporting a new feature label Aug 10, 2023
@dgarijo dgarijo self-assigned this Aug 10, 2023
@dgarijo
Copy link
Owner

dgarijo commented Aug 10, 2023

@psiotwo sorry, this behavior is not supported at the moment. You may always inject your content in the generated html files, but it's not optimal.
The way to implement this feature would be by extending the conf.properties file that Widoco uses, adding the paths to the sections in case of need.

@dgarijo
Copy link
Owner

dgarijo commented Aug 10, 2023

Also, just for intro/description you may use the properties dc:abstract in the ontology (that text will go in the abstract) and rdfs:comment / dc:description. But for more elaborated sections you may want the above solution

@psiotwo
Copy link
Contributor Author

psiotwo commented Aug 10, 2023

Thanks for response @dgarijo . I would be more than happy to configure as much as possible from inside the OWL file. But I am not sure which props to use to populate the Introduction/Description sections, i.e. to have a text along side of the diagram. I am only able to populate the Abstract using dcterms:abstract.

@dgarijo dgarijo added this to the v1.4.xx milestone Aug 10, 2023
@dgarijo
Copy link
Owner

dgarijo commented Aug 10, 2023

I created https://github.com/dgarijo/Widoco/blob/master/doc/metadataGuide/guide.md to document all the metadata properties that are now recognized.

But I double checked and the abstract is the only property used right now for changing the place holders in the HTML. Probably description should be used for the description section (images are used if available).

As for introduction, I am not sure. Will have to check for alternatives (I don't know if there is something like extended abstract or similar). I plan to spend some time in the next couple of weeks to address pressing issues, so I will try to come up with a solution

@dgarijo dgarijo added the pressing Will fix issue in next release label Aug 10, 2023
@psiotwo
Copy link
Contributor Author

psiotwo commented Aug 11, 2023

Perfect, thanks a lot - my use case is to automatically use WIDOCO inside Gitlab pipelines, so IMHO having as much configuration as possible read directly from OWL vocabulary would be an excellent extension to WIDOCO for this sort of applications.

@dgarijo
Copy link
Owner

dgarijo commented Aug 25, 2023

I have pushed a fix so you can address this from ontology annotations. I will do a release soon with the JAR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature request for supporting a new feature pressing Will fix issue in next release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants