Merge: doc/commands: introduce CmdEntityLink command
authorJean Privat <jean@pryen.org>
Fri, 4 May 2018 19:37:03 +0000 (15:37 -0400)
committerJean Privat <jean@pryen.org>
Fri, 4 May 2018 19:37:03 +0000 (15:37 -0400)
commit36c9933cb7fbefe56ee367690ad3e437097a7164
tree186570ae327b27cdc3ab34767d98f2e1e1a9b809
parentf7909344fe6d7165c9a9120b2963842001c043e6
parent56f8b6c7924e2f0a268bb669985b08dd77af69b0
Merge: doc/commands: introduce CmdEntityLink command

This PR introduce the CmdEntityLink command.

The link command is used to create a link from the generated documentation file to an external resource.

Command forms:
* `[[popcorn]]` generates a link to the `popcorn` package documentation resource.
* `[[popcorn | text: foo, title: bar]]` allows customization of link text and title.

The resource URL depends on the tool.

For example:
* `nitweb` (when the command is used in `docdown` or in a `README`) renders a link to the HTML documentation page on the server
* `nitdoc` (TODO) renders a link to the static documentation page
* `nitx` replaces the link commands by the comment commands (that contains the file location)

Pull-Request: #2641
Reviewed-by: Lucas Bajolet <r4pass@hotmail.com>