Anpassen des Eintrags im Softwareverzeichnis

Auf dieser Seite erhalten Sie einen kurzen Überblick darüber, wie Ihr Projekt im Softwareverzeichnis angezeigt wird und Sie dies am Besten anpassen können. Dafür ist vor allem Ihre publiccode.yml-Datei von Bedeutung.

Die folgende Abbildung zeigt die Detailseite eines Eintrags im Softwareverzeichnis. Dabei sind die Einträge auf der Seite den entsprechenden Schlüsseln aus der publiccode.yml-Datei zugeordnet worden.

Wie füge ich eine Beschreibung hinzu?

Unter der Kategorie description können einfache Markdown-Elemente verwendet werden, um die Formatierung der Beschreibung Ihres Projektes Ihren Wünschen anzupassen. So kann ein Beschreibung (longDescription) zum Beispiel wie folgt aussehen:

description:
    de:
        longDescription: |
            **Fettdruck**

            Beschreibungstext mit einer *kursiven Schriftsetzung*
            sowie einer Liste mit folgenden Einträgen

            - Erster Listeneintrag
            - Zweiter Listeneintrag
            - Dritter Listeneintrag 
            mit einem [Link zu der Webseite von openCode](https://opencode.de)

            1. Eine nummerische Aufzählung wird so erzeugt
            2. Es können dabei auch ...
            - verschiedene Level bei einer Aufzählung genutzt werden
            - und dabei sogar verschiedene Formen der Auflistung kombiniert werden.
            - Die Einrückung einer neuen Ebene orientiert sich am Anfang des ersten Zeichens.

            Abschnitte werden erstellt, wenn sie eine leere Zeile hinzufügen.
            Diese können ihre Beschreibung zusätzlich auflockern und übersichtlicher gestalten.

            **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.

Das obige Beispiel illustriert auch die verschiedenen Markdown-Gestaltungselemente, die Sie für eine Beschreibung nutzen können.

Diese Beschreibung sieht im Softwareverzeichnis dann wie folgt aus:

Hinweis

Zur besseren Barrierefreiheit muss darauf geachtet werden,dass die Beschreibungstexte jeweils der richtigen Sprache zugeordnet worden. Eine Beschreibung auf deutsch sollte sich unter dem Sprachcode de, und eine Beschreibung auf englisch unter dem Sprachcode en befinden. Hier finden Sie ein Beispiel, indem eine Beschreibung auf deutsch und englisch notiert wurde:

description:
    de:
        shortDescription: >-
        Die anpassungsfähige Office- und Kollaborations-Suite für die Öffentliche Verwaltung.
    en:
        shortDescription: >-
        The adaptable office and collaboration suite for the public administration.

Wie kann ich meine Software einer Software-Suite zuordnen?

In der publiccode.yml kann mit dem Schlüssel softwareSuite die eigene Software einer Software-Suite zugeordnet werden. Dieser ordnet den Eintrag im Softwareverzeichnis einem übergeordneten Projekt zu:

Wie füge ich Badges hinzu?

Ihr Projekt kann, wenn es die nötigen Voraussetzungen erfüllt, mit verschiedenen Badges ausgezeichnet werden. Diese zeigen den Status des Projektes im Bezug auf Sicherheit, Wartung und Nachnutzung. In der Dokumentation der Badges finden Sie genauere Informationen zu den Voraussetzungen der einzelnen Badges und wie Sie diese erhalten.

Wie reiche ich eine Nachnutzung ein?

Zum Einreichen eines Nachnutzungsrechts Ihrer Software müssen Sie diesen Schritten folgen:

1. Klicken Sie zuerst auf der Seite Nutzung sichtbar machen auf Nachnutzung einreichen. Sie werden nun auf die Suche von openCode weitergeleitet.
2. Öffnen Sie hier nun den Eintrag des Projekts, welcher Ihrem Suchbegriff entspricht.
3. Nach einem Klicken auf Nachnutzung einreichen wird das Formular zur endgültigen Bestätigung der entsprechenden Nachnutzung geöffnet.

Nachdem Sie dieses Formular ausgefüllt und abgeschickt haben, haben Sie die Nachnutzung erfolgreich eingereicht.

Häufig gestelle Fragen und Probleme

Warum wird mein Projekt nicht im openCode Softwareverzeichnis angezeigt?

Dies liegt vermutlich daran, dass Ihre publiccode.yml-Datei fehlerhaft ist oder Einträge in Ihrer publiccode.yml-Datei vergessen wurden. Eine Anleitung zum Erstellen der publiccode.yml finden Sie hier im Guide.