Customizing the entry in the software directory

This page provides a brief overview of how your project is displayed in the software directory and how you can best customize it. Your publiccode.yml file is particularly important for this.

The following figure shows the details page of an entry in the software directory. The entries on the page have been assigned to the corresponding keys from the publiccode.yml file.

Frequently asked questions and problems

How do I add a description?

Under the description category, simple Markdown elements can be used to customize the formatting of your project description. For example, a description (longDescription) could look like this:

description:
    de:
        longDescription: |
            **Bold Text**

            Description text with *italic font*
            and a list with the following entries

            - First list entry
            - Second list entry
            - Third list entry 
            with a [link to the openCode website](https://opencode.de)

            1. A numbered list is created as follows
            2. It is also possible to ...
            - use different levels in a list
            - and even combine different types of lists.
            - The indentation of a new level is based on the beginning of the first character.

            Sections are created when you add a blank line.
            These can also break up your description and make it clearer.

            **Beachten Sie**: Vor und nach einer Liste muss immer eine leere Zeile kommen,
            ansonsten werden diese nicht als Liste erkannt. Am besten machen sie, genauso
            wie in dieser Beschreibung, einfach nach jedem verschiedenen Block eine leere Zeile.

The above example also illustrates the various Markdown design elements that you can use for a description.

This description then appears as follows in the software directory:

Note

For better accessibility, care must be taken to ensure that the description texts are assigned to the correct language. A description in German should be under the language code de, and a description in English under the language code en. Here is an example where a description has been noted in German and English:

description:
    de:
        shortDescription: >-
        The adaptable office and collaboration suite for public administration.
    en:
        shortDescription: >-
        The adaptable office and collaboration suite for public administration.

How can I assign my software to a software suite?

In publiccode.yml, you can assign your own software to a software suite using the softwareSuite key. This assigns the entry in the software directory to a parent project:

How do I add badges?

If your project meets the necessary requirements, it can be awarded various badges. These show the status of the project in terms of security, maintenance, and reuse. In the badge documentation, you will find more detailed information about the requirements for each badge and how to obtain them.

How do I submit a reuse?

To submit a reuse for a software, you must follow these steps:

1. First, click on Submit use on the Activate Reuse page. You will now be redirected to the openCode search.
2. Now open the project entry that matches your search term.
3. After clicking on Submit use, the form for final confirmation of the corresponding reuse will open.

Once you have completed and submitted this form, you have successfully submitted the reuse.

Why is my project not displayed in the openCode software directory?

This is probably because your publiccode.yml file is incorrect or entries in your publiccode.yml file have been forgotten. Instructions for creating the publiccode.yml can be found here in the guide.