openta Dokument Nr. 1 März Namensnennung ITAS,

Transkript

1 Formale Kategorisierung openta Newsdienst openta Dokument Nr. 1 Stand: , Version 1.0 Autor: Christian Schmitt (KIT IAI) Zusammenfassung und Zielgruppe: Dieses Dokument beschreibt, wie in News Feeds der NTA Institutioneerster Linie an die Internetbeauftragtenn der institutionellen Mitglieder dess NTA. Der einzelne News Einträge kategorisiert werden können. Es richtet sich in openta Newsdienst wird durch zwei weitere Dokumente ergänzend beschrieben: openta Newsdienst Ziele, Verfahren, Nutzung (openta Dokument Nr. 2) openta Newsdienst Technisches Handbuch (openta Dokument Nr. 3) Kontakt: info@openta.net Die openta Dokumente sind abrufbar unter der Adresse http: // und openta dokumente Versionsgeschichte: März 2013 erster Entwurf Januar 2014 Version 1.0 (nur redaktionelle Änderungen) Rechtehinweis: CC BY SA 4.0 Namensnennung Weitergabe unter gleichen Bedingungen 4.00 International Im Rahmen des Forschungsvorhabens Kooperativer Aufbau eines Fachportals Technik folgenabschätzung, gefördert durch die DFG, durchgeführt von v den KIT Instituten ITAS, IAI und der Bibliothek. Gefördert durch die

2

3 Inhaltsverzeichnis Inhaltsverzeichnis 1 Vorwort Formale Kategorien von openta Verwendung in Web Feeds Verwendung in Atom Feeds Verwendung in RSS Feeds Anhang A: APP Kategorie Dokument für die formalen Kategorien von openta Tabellenverzeichnis Tab. 1: Formale openta Nachrichtenkategorien (de/en)... 5 Tab. 2: Formale openta Kategorien hierarchische und flache Struktur (de/en)... 6 Tab. 3: Formale openta Kategorien (de/en) mit Term Attribut von 10

4

5 1 Vorwort 1 Vorwort Im Rahmen des DFG Projektes openta wird ein Dienst entwickelt, welcher Neuigkeiten aus der TA Community aufsammelt, aufbereitet und integriert bereitstellt. Im Folgenden wird beschrieben, wie in News Feeds der NTA Institutionen einzelne News Einträge kategorisiert werden können, damit diese sich im openta Newsdienst themenspezifisch und institutionsübergreifend zusammenfassen lassen. 2 Formale Kategorien von openta Im Rahmen des openta Projekts wurde folgende Hierarchie von Kategorien für die formale Klassifizierung von Nachrichten (und anderen Inhalten) definiert: Tab. 1: Formale openta Nachrichtenkategorien (de/en) Deutsch 1. Angebot 1. Stellenangebot 2. Kooperationsangebot 3. Sonstiges 2. Institutionelles 1. Personalia 2. Sonstiges 3. Projekt 4. Publikation 5. Veranstaltung 1. Call for Papers 2. Ankündigung 3. Bericht 6. Sonstige 3 Verwendung in Web Feeds Englisch 1. offer 1. job offer 2. cooperation offer 3. other 2. institutional matters 1. personel matters 2. other 3. project 4. publication 5. event 1. call for papers 2. announcement 3. report 6. other Zur Verbreitung von Nachrichten in Form von Web Feeds gibt es zwei relevante Standards, die RSS Format Familie und das Atom Format. Beide Standards erlauben die Angabe von Kategorien um eine semantische Einordnung der jeweiligen Einträge zu ermöglichen. Eine hierarchische Gliederung der einzelnen Kategorien ist jedoch nicht vorgesehen, so dass die Hierarchie in einer flachen Struktur abgebildet werden muss. Für openta wurde dies durch Voranstellen der übergeordneten Kategorie realisiert, wobei die Hierarchiestufen durch einen Schrägstrich (/) getrennt werden. Daraus ergibt sich folgendes Schema: 5 von 10

6 3 Verwendung in Web Feeds Tab. 2: Formale openta Kategorien hierarchische und flache Struktur (de/en)hierarchische Struktur 1. Angebot 1. Stellenangebot 2. Kooperationsangebot 3. Sonstiges 2. Institutionelles 1. Personalia 2. Sonstiges 3. Projekt 4. Publikation 5. Veranstaltung 1. Call for Papers 2. Ankündigung 3. Bericht 6. Sonstige Flache Struktur/de Flache Struktur/en Angebot offer Angebot/Stellenangebot offer/job offer Angebot/Kooperationsangebot offer/cooperation offer Angebot/Sonstiges offer/other Institutionelles institutional matters Institutionelles/Personalia institutional matters/personnel matters Institutionelles/Sonstiges institutional matters/other Projekt project Publikation publication Veranstaltung event Veranstaltung/Call for Papers event/call for papers Veranstaltung/Ankündigung event/announcement Veranstaltung/Bericht event/report Sonstige other Sofern ein Content Management System (CMS) für die Erzeugung der Feeds eingesetzt wird und dieses das Anlegen von Kategorien ermöglicht, sollten dort die Einträge wie in den beiden rechten Spalten der obigen Tabelle (flache Struktur, de oder en) angelegt werden. Wenn diese Möglichkeit nicht besteht, kann der zuständige System Administrator eventuell weiterhelfen. Sollte im CMS die Angabe eine Referenz auf ein Klassifikationsschema für die jeweiligen Kategorien möglich sein, ist die korrekte Referenz: Wenn es nicht möglich ist, eine solche Schema Referenz zu setzen und die Kategorien von openta dennoch klar von anderen Kategorien getrennt werden sollen, kann jeder Kategorie die Zeichenfolge openta/ vorangestellt werden. 3.1 Verwendung in Atom Feeds Im Zusammenhang mit Atom Feeds sind zwei Standards relevant. Zum Beschreiben von Feed Inhalten gibt es das Atom Syndication Format (ASF) 1, zum anderen für die standardisierte Verbreitung und Bearbeitung von ASF basierten Inhalten das Atom Publishing Protocol (AtomPub / APP) 2. Für jeden Eintrag in einem ASF Feed kann eine beliebige Anzahl von Kategorien in folgendem Format angeben werden: <category term="foo" scheme=" label="foo"> Die Angabe für das term Attribut definiert hierbei den maschinenlesbaren Schlüssel der Kategorie, die optionale Angabe des scheme Attributs definiert die Referenz auf ein Kategorie Dokument, welches den kompletten Katalog der möglichen Kategorien beschreibt. Das label Attribut beschreibt für Menschen lesbar den Namen der jeweiligen Kategorie. Die Werte für das Term Attribut sind wie folgt: 1 The Atom Syndication Format: 2 The Atom Publishing Protocol: 6 von 10

7 3 Verwendung in Web Feeds Tab. 3: Formale openta Kategorien (de/en) mit Term Attribut Deutsch Englisch Term 1. Angebot 1. offer angebot 1. Stellenangebot 1. job offer angebot stelle 2. Kooperationsangebot 2. cooperation offer angebot koop 3. Sonstiges 3. other angebot misc 2. Institutionelles 2. institutional matters inst 1. Personalia 1. personel matters inst pers 2. Sonstiges 2. other inst misc 3. Projekt 4. Publikation 5. Veranstaltung 3. project 4. publication 5. event projekt pub veranst 1. Call for Papers 1. call for papers veranst call 2. Ankündigung 2. announcement veranst ankuend 3. Bericht 3. report veranst bericht 6. Sonstige 6. other misc Das Format des Dokuments ist im Rahmen des APP standardisiert (vgl. Anhang A). Der Wert des scheme Attributs sollte die URL sein, unter welcher das Dokument abrufbar ist. Für die formalen Kategorien von openta ist dies: de: en: Beispiele Die Beispiele enthalten jeweils zwei Kategorie Einträge, zum einen zur openta Kategorie Stellenangebot unterhalb von Angebot (1.1) und zum anderen zur Kategorie Projekt (3): Beispiel 1: Empfohlene Notation <entry xmlns=" <id>beispiel-id</id> <updated> t12:30:02z</updated> <category scheme=" term="angebot-stelle /> label="angebot/stellenangebot /> <category scheme=" term="projekt" label="projekt" /> </entry> Beispiel 2: Notation, falls Angabe der Schema Referenz nicht möglich Wenn die Angabe des scheme Attributs nicht möglich ist, kann dies auch weggelassen werden. Der Eintrag wird trotzdem von openta korrekt erkannt. Die Angabe verliert jedoch an Kontext, da von neutralen Readern nicht mehr ausgewertet werden kann, welche Kategorien aus demselben Schema stammen. Zum besseren Verständnis kann dann auch das deutsche oder englische Label verwendet werden: 7 von 10

8 3 Verwendung in Web Feeds <entry xmlns=" <id>beispiel-id</id> <updated> t12:30:02z</updated> <category term="angebot/stellenangebot"/> <category term="projekt"/> </entry> Beispiel 3: Notation, falls Angabe der Schema Referenz nicht möglich und klare Abtrennung der openta Kategorien von anderen Kategorien gewünscht Wenn aufgrund der nicht vorhandenen scheme Angabe die formalen Kategorien von openta trotzdem als solche gekennzeichnet werden sollen, um sie evtl. von anderen verwendeten Schemata zu unterscheiden, kann dies durch Voranstellen des Präfix open TA/ bewerkstelligt werden. <entry xmlns=" <id>beispiel-id</id> <updated> t12:30:02z</updated> <category term="openta/angebot/stellenangebot"/> <category term="openta/projekt"/> </entry> 3.2 Verwendung in RSS Feeds RSS ist eine Familie von Dateiformaten, welche alle XML basiert sind. Je nach Version des Formats werden unterschiedliche Funktionalitäten unterstützt. Die Angabe der Kategorien ist jedoch bei sämtlichen Versionen identisch. Für jeden Eintrag in einem RSS Feed kann eine beliebige Anzahl von Kategorien in folgendem Format angeben werden: <category domain= >foo</category> Der Wert des category Tags definiert hierbei den Namen der Kategorie, die optionale Angabe des domain Attributs definiert die Taxonomie. Für die Angabe dieser Taxonomie gibt es keinen Standard, es wird jedoch eine URL empfohlen. Da in RSS auch kein Standard für die über die URL referenzierte Beschreibung der Kategorien existiert, soll das Kategorie Dokument des APP referenziert werden: de: en: Beispiele Die Beispiele enthalten jeweils zwei Kategorie Einträge, zum einen zur openta Kategorie Stellenangebot unterhalb von Angebot (1.1) und zum anderen zur Kategorie Projekt (3): 8 von 10

9 3 Verwendung in Web Feeds Beispiel 1: Empfohlene Notation <item> <guid>beispiel-id</guid> <pubdate> t12:30:02z</pubdate> <category domain=" Angebot/Stellenangebot</category> <category domain=" Projekt</category> </item> Beispiel 2: Notation, falls Angabe der Domain Referenz nicht möglich Wenn die Angabe des domain Attributs nicht möglich ist, kann dies auch weggelassen werden. Der Eintrag wird trotzdem von openta korrekt erkannt. Die Angabe verliert jedoch an Kontext, da von neutralen Readern nicht mehr ausgewertet werden kann, welche Kategorien aus demselben Schema stammen. <item> <guid>beispiel-id</guid> <pubdate> t12:30:02z</pubdate> <category>angebot/stellenangebot</category> <category>projekt</category> </item> Beispiel 3: Notation, falls Angabe der Domain Referenz nicht möglich und klare Abtrennung der openta Kategorien von anderen Kategorien gewünscht Wenn aufgrund der nicht vorhandenen domain Angabe die formalen Kategorien von openta trotzdem als solche gekennzeichnet werden sollen, um sie evtl. von anderen verwendeten Schemata zu unterscheiden, kann dies durch Voranstellen des Präfix open TA/ bewerkstelligt werden. <item> <guid>beispiel-id</guid> <pubdate> t12:30:02z</pubdate> <category>openta/angebot/stellenangebot</category> <category>openta/projekt</category> </item> 9 von 10

10 4 Anhang A: APP Kategorie Dokument für die formalen Kategorien von openta 4 Anhang A: APP Kategorie Dokument für die formalen Kategorien von openta Deutsch URL: Inhalt: <categories xmlns=" xmlns:atom=" <atom:category term="angebot" label="angebot" /> <atom:category term="angebot-stelle" label="angebot/stellenangebot" /> <atom:category term="angebot-koop" label="angebot/kooperationsangebot" /> <atom:category term="angebot-misc" label="angebot/sonstiges" /> <atom:category term="inst" label="institutionelles" /> <atom:category term="inst-pers" label="institutionelles/personalia" /> <atom:category term="inst-misc" label="institutionelles/sonstiges" /> <atom:category term="projekt" label="projekt" /> <atom:category term="pub" label="publikation" /> <atom:category term="veranst" label="veranstaltung" /> <atom:category term="veranst-call" label="veranstaltung/call for Papers" /> <atom:category term="veranst-ankuend" label="veranstaltung/ankündigung" /> <atom:category term="veranst-bericht" label="veranstaltung/bericht" /> <atom:category term="misc" label="sonstige" /> </categories> Englisch URL: Inhalt: <categories xmlns=" xmlns:atom=" <atom:category term="angebot" label="offer" /> <atom:category term="angebot-stelle" label="offer/job offer" /> <atom:category term="angebot-koop" label="offer/cooperation offer" /> <atom:category term="angebot-misc" label="offer/other" /> <atom:category term="inst" label="institutional matters" /> <atom:category term="inst-pers" label="institutional matters/personnel matters" /> <atom:category term="inst-misc" label="institutional matters/other" /> <atom:category term="projekt" label="project" /> <atom:category term="pub" label="publication" /> <atom:category term="veranst" label="event" /> <atom:category term="veranst-call" label="event/call for papers" /> <atom:category term="veranst-ankuend" label="event/announcement" /> <atom:category term="veranst-bericht" label="event/report" /> <atom:category term="misc" label="other" /> </categories> 10 von 10