Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

spec: Allow <icon> tags in generic components #138

Merged
merged 2 commits into from Oct 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -283,8 +283,8 @@
This icon type may have <literal>width</literal> and <literal>height</literal> properties.
</para>
<para>
<literal>remote</literal> icons loaded from a remote URL. Currently, at least HTTP urls must be supported.
This icon type may have <literal>width</literal> and <literal>height</literal> properties.
<literal>remote</literal> icons loaded from a remote URL. Currently, only HTTP urls are supported.
This icon type should have <literal>width</literal> and <literal>height</literal> properties.
</para>
<para>
Examples of the different methods to specify an icon:
@@ -143,6 +143,30 @@
</listitem>
</varlistentry>

<varlistentry id="tag-icon">
<term>&lt;icon/&gt;</term>
<listitem>
<para>
The <code>&lt;icon/&gt;</code> tag describes the component icon. It is mostly used for GUI applications (component-type <literal>desktop-application</literal>).
It can be of the type <literal>stock</literal>, <literal>local</literal>,
or <literal>url</literal>.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be remote, but I can quickly fix that after merging the patch.

</para>
<para>
<literal>stock</literal> icons are loaded from stock. The icon name should never include any file-extension or path.
</para>
<para>
<literal>local</literal> icons are loaded from a file in the filesystem.
They should specify a full file path.
This icon type may have <literal>width</literal> and <literal>height</literal>
properties.
</para>
<para>
<literal>remote</literal> icons loaded from a remote URL. Currently, only HTTP urls are supported.
This icon type should have <literal>width</literal> and <literal>height</literal> properties.
</para>
</listitem>
</varlistentry>

<varlistentry id="tag-description">
<term>&lt;description/&gt;</term>
<listitem>