diff --git a/docs/metainfo_syntax.md b/docs/metainfo_syntax.md
index 8710ba9..f816869 100644
--- a/docs/metainfo_syntax.md
+++ b/docs/metainfo_syntax.md
@@ -1,120 +1,120 @@
# Description of the metainfo.yml syntax {#metainfo_syntax}
The name is the folder name.
The fancyname is the project name used in CMake.
Each group must contain one and only one library with the `group_info` block. If
more are defined, the behavior is unknown.
**Be sure to to set `public_lib` to true, or the library will be ignored.** Most of
the other keys are optionals. See below for a simplier example.
## All possible keys.
```yaml
description: Library doing X and Y
fancyname: The FancyName # optional, else replaced by the `project()` value of the `CMakeLists.txt`
maintainer: ochurlaud # optional, replaced by The KDE Community
group: frameworks # optional
subgroup: tier 1 # optional, a group must be defined
type: functional # optional
logo: relative/path/to/logo.png # Used only if not part of a group
platforms: # optional, name accepted: all, Linux, Windows, MacOSX
- name: Linux
note: Functional only with running BlueZ 5 # optional
public_lib: true # if not defined, the library is ignored
public_source_dirs: # optional, default to src, must be a list
- src1
- src2
public_doc_dir: docs # optional, default to docs
public_example_dir: examples # optional, default to examples
portingAid: true/false # optional, default to false
deprecated: true/false # optional, default to false
libraries: KF5::MyLib # optional
libraries: # optional
- qmake: BluezQt
cmake: KF5::BluezQt
cmakename: KF5BluezQt # optional
irc: kde # optional, overwrite group field, if both not defined, default to kde-devel
mailinglist: mylib-dev # optional, overwrite group field, if both not defined, default to kde-devel
group_info: # optional, only once per group
name: frameworks # optional, else the name is defined by the 'group' key above.
fancyname: The KDE Frameworks
maintainer: dfaure
irc: kde-devel
mailinglist: kde-core-devel
platforms:
- Linux
- Windows (partial)
- MacOSX (partial)
description: Providing everything from simple utility classes to ..
logo: relative/path/to/logo.png
long_description: # optional, one item per paragraph, html authorized
- - The KDE Frameworks build on the Qt
+ - The KDE Frameworks build on the Qt
framework, providing everything from simple utility classes (such as
those in KCoreAddons) to integrated solutions for common requirements of
desktop applications (such as KNewStuff, for fetching downloadable add-on
content in an application, or the powerful KIO multi-protocol file access
framework).
- ....
subgroups: # every subgroup must be declared here or will be ignored
- name: Tier 1
description: Tier 1 frameworks depend only on Qt (and possibly a small number of other third-party libraries), so can easily be used by an Qt-based project.
- name: Tier 2
description: Tier 2 frameworks additionally depend on tier 1 frameworks, but still have easily manageable dependencies.
- ..
```
## Simple example 1
In this case, the library is not part of a group, and the source is in `src`. If
there is no logo, a default one is used.
```yaml
description: Library doing X
maintainer: ochurlaud
public_lib: true
logo: libX.png
```
## Simple example 2
In this case, the libraries X and Y are part of the same group `XY`, and the
source is in `src`.
### libX
```yaml
description: Library doing X
maintainer: ochurlaud
public_lib: true
platforms:
- name: Linux
- name: Windows
note: doesn't work with Windows10
group: XY
group_info:
fancyname: XY Libraries
maintainer: arandomguy
platforms:
- Linux
- Windows (partial)
description: XY provides ...
logo: logo_XY.png
long_description:
- XY does this and this
- If you want to contribute please write to ...
```
### libY
```yaml
description: Library doing Y
maintainer: otherrandomguy
public_lib: true
platforms:
- name: Linux
group: XY
```
diff --git a/metainfo.yaml b/metainfo.yaml
index 2c27324..eb829e2 100644
--- a/metainfo.yaml
+++ b/metainfo.yaml
@@ -1,64 +1,64 @@
maintainer: ochurlaud
description: Scripts and data for building API documentation (dox) in a standard format and style
tier: 1
type: functional
platforms:
- name: Linux
- name: FreeBSD
- name: Windows
- name: MacOSX
portingAid: false
deprecated: false
release: true
group: Frameworks
subgroup: Tier 1
public_lib: true
public_source_dirs:
- src
group_info:
name: frameworks
fancyname: The KDE Frameworks
maintainer: dfaure
mailinglist: kde-frameworks-devel
platforms:
- Linux
- FreeBSD (partial)
- Windows (partial)
- MacOSX (partial)
- Android (partial)
description: Providing everything from simple utility classes to integrated solutions for common requirements of desktop applications
logo: konqi_frameworks.png
long_description:
- - The KDE Frameworks build on the Qt
+ - The KDE Frameworks build on the Qt
framework, providing everything from simple utility classes (such as
those in KCoreAddons) to integrated solutions for common requirements of
desktop applications (such as KNewStuff, for fetching downloadable add-on
content in an application, or the powerful KIO multi-protocol file access
framework).
- The KDE Frameworks can be used in CMake-based and QMake-based projects,
and most of them are portable to at least Windows, Mac and Linux. The
documentation of each framework has code snippets that show how to include
the framework in a QMake or CMake project.
- The frameworks are divided into four tiers, based on the kind of
dependencies that they have. For instance, Tier 1 frameworks depend on Qt
and possibly some third-party libraries, but not on other frameworks. This
makes them easy to integrate into existing applications.
subgroups:
- name: Tier 1
order: 1
description: Tier 1 frameworks depend only on Qt (and possibly a small number of other third-party libraries), so can easily be used by any Qt-based project.
- name: Tier 2
order: 2
description: Tier 2 frameworks additionally depend on tier 1 frameworks, but still have easily manageable dependencies.
- name: Tier 3
order: 3
description: Tier 3 frameworks are generally more powerful, comprehensive packages, and consequently have more complex dependencies.
- name: Tier 4
order: 4
description: Tier 4 frameworks can be mostly ignored by application programmers; this tier consists of plugins acting behind the scenes to provide additional functionality or platform integration to existing frameworks (including Qt).
- name: Porting Aids
order: 5
description: Porting Aids frameworks provide code and utilities to ease the transition from kdelibs 4 to KDE Frameworks 5. Code should aim to port away from this framework, new projects should avoid using these libraries.
diff --git a/src/kapidox/data/templates/libinfo.html b/src/kapidox/data/templates/libinfo.html
index be254c5..fc3150b 100644
--- a/src/kapidox/data/templates/libinfo.html
+++ b/src/kapidox/data/templates/libinfo.html
@@ -1,54 +1,45 @@