Contribute¶

The HIG is written in reStructuredText, a lightweight markup language. For example the chapter heading together with the first paragraph looks like this in reStructuredText

Contribute
==========

The HIG is written in
`reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_, a light
weight markup language. For example the chapter heading together with the
first paragraph looks like this in reStructuredText

The restructuredText of the full HIG is organized into several source files. You can view and modify these source files with any text editor.

The source files are hosted in a Git repo. Sphinx is used to generate HTML pages from these source files. Tasks and changes are organized via https://invent.kde.org.

Note

On every page of the HIG, there is a View page source link in the top right corner.

For more information and help you can find us on Matrix, IRC or Telegram.

If you are new to KDE development, make sure to read how to become a KDE developer first.

Getting Started¶

Install some tools with your distro’s package manager:

Distribution	Command
Arch, Manjaro	`sudo pacman -S git make python`
Debian, Ubuntu, KDE Neon	`sudo apt install git make python3`
openSUSE	`sudo zypper install git-core python3 python3-devel`
Fedora	`sudo dnf install git make python3`
CentOS/RHEL	`sudo yum install git make python3`

Clone the HIG source code repository into an empty folder:

git clone https://invent.kde.org/websites/hig-kde-org.git
cd hig-kde-org

Create a Python 3 virtual environment, enable it and install the requirements from requirements.lock into it:
```
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.lock
```

Now you are ready to contribute to the HIG! To preview changes on your local machine, enter the directory of a website (HIG or Kirigami) and use make to generate the HTML version of the documentation. For example:

cd HIG
make html

You will find the documentation inside build/html within the corresponding website directory. Open build/html/index.html in your browser (e.g. run xdg-open build/html/index.html)

Page Structure¶

This defines the structure that should be used for writing pattern and component pages for the HIG.

Pattern¶

Pattern name
==============

Give a short into into the pattern.

Examples
--------

Showcase the pattern with videos or images.

When to use
-----------

Describe when to use this pattern and when not to use it.

How to use
----------

Describe how to use this pattern.

Pages about patterns should not include any details on implementation, about behavior or appearance, but rather link to the corresponding components needed to implement a pattern.

Optional: you can add subsections for desktop and mobile.

When to use
-----------

Desktop
^^^^^^^

Mobile
^^^^^^

Component¶

Component name
==============

Purpose
-------

A very short description on why and how to use the component. This should
primarily link to the corresponding pattern pages.

Example
-------

Showcase the component with a video or image.

Guidelines
----------

Is this the right control?
~~~~~~~~~~~~~~~~~~~~~~~~~~

Describe when to use a component and when not.

Behavior
~~~~~~~~

Describe the behavior of the component.

Appearance
~~~~~~~~~~

Describe the appearance of the component.

Code
----

Kirigami
~~~~~~~~

Link to the API and example code how to use the component with QML and
Kirigami.

Qt Widgets
~~~~~~~~~~

Link to the API and example code how to use the component with Qt Widgets.

Optional: you can add subsections for desktop and mobile.

Behavior
~~~~~~~~

Desktop
"""""""

Mobile
""""""

Code Examples¶

Adding examples to the HIG is very easy.

Add a file with source code in the ./examples/ folder.

Add the following markup at the point you want to insert the example:

.. literalinclude:: /../../examples/kirigami/InlineMessage.qml
   :language: qml

Creating media¶

See Generate media on how to create media files for the HIG.