search

Open-CMSIS-Pack / Open-CMSIS-Pack-Spec

Common Microcontroller Software Interface Standard - Pack(age) based distribution system
https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/
Apache License 2.0
50 stars 20 forks source link

Are links to web pages allowed in the `book` element? #220

Closed silviooliva closed 1 year ago

silviooliva commented 1 year ago

Both in the /package/boards/board/book and in the /package/devices/family/.../book description it is not clear if the links to web pages can be used. In the description of the name attribute there is only the reference to the file extension of the document and its path in the package. Instead, in the description of the public attribute it is reported: "Links to web pages are assumed to be public." so I'm led to think that also the external URLs can be used. Could this point be clarified?

If the URLs are allowed, maybe a short sentence like the following one could be added to the description of the name attribute: "The link to a document on an external web site is also allowed."

jkrech commented 1 year ago

The straight answer is: YES https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_boards_pg.html#element_board_book https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_family_pg.html#element_book

Needs to be extended to explicitly mention the option to specify a url of a web site hosting the book.

silviooliva commented 1 year ago

Hi @jkrech, if you agree I can open a PR with the explicit mention to the url in the book element description.

jkrech commented 1 year ago

Documentation got updated.