Skip to content

Commit

Permalink
Added section "Link to external documentation" (#245)
Browse files Browse the repository at this point in the history
  • Loading branch information
mprinkezs authored Jan 6, 2025
1 parent f1e9d6f commit 63676ce
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion doc/howtos/app_documentation/app_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,28 @@ See [Documentation](Documentation.pdf) for detailed description.

## Converting Markdown files to PDF

The [Visual Studio Code](https://code.visualstudio.com/) extension [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf) allows to convert a Markdown file to PDF.
The [Visual Studio Code](https://code.visualstudio.com/) extension [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf) allows to convert a Markdown file to PDF.

## Link to external documentation

![New in Version 2025](https://img.shields.io/badge/New-Version_2025-orange)

You can create a link to a website providing App documentation by adding a JSON object `"documentation": "<url>"` to the App's `metainfo.json` file:

```{code-block}
:caption: Example documentation link in `metainfo.json`
{
...
"documentation": "https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html",
...
}
```

If a documentation link is defined in an App, each dialog window will provide a help button in its title bar.

![App dialog window with help button](assets/dialog_help_button.png)

When the help button is clicked, the user must confirm that the linked documentation pages is openened in the system's web browser.

![Open documentation page confirmation dialog](assets/open_documentation_confirmation.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 63676ce

Please sign in to comment.