Skip to content

Commit

Permalink
Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
mprinkezs committed Sep 10, 2024
1 parent 5285437 commit e2da605
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
9 changes: 6 additions & 3 deletions doc/howtos/app_documentation/app_documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Documenting Apps

💡 The App documentation is part of the packaged App.
```{note}
The App documentation is part of the packaged App.
```

```{eval-rst}
.. toctree::
Expand All @@ -23,8 +25,9 @@

## App documentation structure

> [!NOTE]
> An App (`.addon` file) is technically a ZIP file. See [App file format](../app_file_format/app_file_format.md) for details.
```{note}
An App (`.addon` file) is technically a ZIP file. See [App file format](../app_file_format/app_file_format.md) for details.
```

* Mandatory contents:
* `doc/README.md` — this will be rendered as the product's splash description ad.
Expand Down
12 changes: 9 additions & 3 deletions doc/howtos/app_file_format/app_file_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## Introduction

💡 An ZEISS INSPECT App file (extension: *.addon) is a ZIP archive with pre-defined folder- and filenames.
```{note}
An ZEISS INSPECT App file (extension: *.addon) is a ZIP archive with pre-defined folder- and filenames.
```

While an App file will be created and modified with the App Editor in most cases, it can also be unzipped/edited/zipped manually if necessary.

Expand All @@ -21,7 +23,9 @@ While an App file will be created and modified with the App Editor in most cases

### Content types

💡 The top level folders determine the "content type". Inside these top level folders, a separate sub folder must be provided for each item.
```{note}
The top level folders determine the "content type". Inside these top level folders, a separate sub folder must be provided for each item.
```

| Folder / Provider name | Content type | Notes |
| ------------------------- | ----------------------------------------------- | ------------ |
Expand Down Expand Up @@ -59,7 +63,9 @@ While an App file will be created and modified with the App Editor in most cases

### Content data

💡 Each "content object" consists of a folder in one of the "content type" (top level) folders.
```{note}
Each "content object" consists of a folder in one of the "content type" (top level) folders.
```

* A "content object" is a single template/script/element/... distributed via an App.
* Each "content object" is represented by the content of a folder in the "content type" folder matching the content type.
Expand Down

0 comments on commit e2da605

Please sign in to comment.