Komma igång med specifikationer¶
Alla specifikationer hanteras i projekt. Syftet med att ha ett projekt är att det möjliggör förvaltning av ett antal resurser som hör till specifikationen, t.ex. ett eller flera dokument. Ett projekt möjliggör också att en plats etableras för att hantera flera versioner av samma specifikation eller flera närliggande specifikationer som förvaltas tillsammans.
Stabila webbadresser¶
En viktig princip är att varje specifikation får en stabil webbadress (URL). En specifikation om hur mätningar av luftkvalitet kan få en adress som ser ut som:
https://dataportal.se/specifications/luft/1.0
I detta exempel är luft projektets namn (två projekt får inte ha samma namn) och 1.0 är specifikationens versionsnummer.
Skapa ett projekt¶
Gå först till https://editera.dataportal.se/workbench där kan du se alla projekt som du skapat (eller någon delat med dig). Om du inte har några projekt ännu ser du endast en knapp för att skapa ett projekt.
Klicka på knappen och ange projektets namn och även hur dess webbadress (URL) ska se ut. Det är också möjligt att ange en längre beskrivning av projektet, notera att denna information inte kommer visas på dataportal.se utan endast är till för administrativa syften på editera. Notera att det namn man anger på projektet kommer bli en del av specifikationens webbadress.
Resultatet är att du nu har en projekt i listan. Om du senare vill ändra projektets namn eller beskrivning klickar du på kugghjulet på projektet och väljer redigera. Du kan också ändra dess webbadress eller ändra delningsinställningar för att bjuda in andra redaktörer att hjälpa till (mer om det senare). Notera att efter att man publicerat ett projekt med en eller flera specifikationer bör man undvika i görligaste mån att ändra webbadressen då det kan leda till brutna länkar.
Skapa en specifikation¶
Klicka dig in i projektet och välj Specifikation under fliken entiteter.
Klicka på knappen Skapa specifikation och fyll i de obligatoriska fälten (specifikationens länk, specifikationstypen, titel och utgivare). När det gäller utgivare så ska du välja i listan den organisation som du representerar. Din organisation ska ha skapats i samband med att du fick din användare, om så inte är fallet eller du vill kunna ange en annan organisation än de som finns i listan får du höra av dig till supporten.
För mer information om de andra fälten kan du klicka på respektive fältnamn så får du upp en beskrivning.
Lägga till en resurs¶
Till specifikationen vill man typiskt knyta en eller flera resurser med roller som exempel, schema, vägledning. För själva specfikationsdokumentet bör man välja rollen specifikation.
För att skapa en resurs växlar du till entiteten Resurs och klicka på Skapa resurs knappen. I skapningsdialogen kan man välja att tillhandahålla resursen genom att ladda upp en fil eller ge en länk. Man måste ange en titel och en roll.
När man skapat en resurs behöver man peka ut den från specifikationen, det gör man genom att växla tillbaka till Specifikation och redigera den specifikation man tidigare skapat. I redigeringsformuläret letar du reda på fältet som heter har resurs och väljer den nyskapade resursen, spara och sen är det klart.
Notera att man förutom att söka direkt inmatningsfältet också kan få upp en dialog där man söka och välja bland alla tillgängliga resurser.
Det är också möjligt att skapa nya resurser direkt från denna dialog genom att klicka på knappen Skapa brevid sökfältet.
Allt du skapar där kommer sen också dyka upp i listan under Resurs.
Ange en kontaktuppgift¶
Till en specifikation vill man ofta ange en kontaktuppgift som ger en ingång för de som har frågor kring specifikationen. Det rekommenderas att ange en funktionsadress, men det är även tillåtet att ange en enskild person.
En kontaktuppgift kan skapas och knytas an till en specifikation alternativt skapas direkt i specifikationens redigeringsformulär på samma sätt som beskrevs för resurs ovan.