Formaatspecificatie
Een open formaat voor je presentaties
Lees, bewaar en genereer decks als gestructureerde data. Gebruik de specificatie om tools te bouwen die met die inhoud werken.
- Bestandsformaat en schema's
Bekijk de velden, valideer een deck en inspecteer het pakket.
- Slidetypes
Zoek een type en bekijk welke inhoudsvelden het gebruikt.
- Compatibiliteit
Bekijk wat een reader moet ondersteunen en hoe die met onbekende inhoud omgaat.
Een slide en de data erachter
Het type bepaalt de structuur van de slide. De inhoudsvelden bevatten de tekst en andere waarden. Een renderer zet die data om in een slide.
Slidedata (uitsnede)
{
"type": "eu.deckyard.slide.quote",
"content": {
"quote": "A deck is data, not a rendering.",
"authorName": "Deckyard",
"authorTitle": "Format specification"
}
}De voorvertoning en het downloadbare deck gebruiken dezelfde inhoud. De code hier is een uitsnede; gebruik het volledige bestand voor validatie.
Een pakket bevat het deck en de bijbehorende bestanden
Het JSON-bestand beschrijft de presentatie. Een deckpakket zet het in een ZIP-archief, samen met het manifest en de meegeleverde bestanden.
Deckpakket application/vnd.deckyard.deck
-
mimetypeMediatype -
manifest.jsonManifest -
deck.jsonDeckdata -
theme.jsonThema, als het een databasethema is -
slide-types/<slug>.jsonEigen slidetypes, als die er zijn -
assets/<sha256>.<ext>Meegeleverde bestanden
Om het deck te tonen heb je een reader en renderer nodig die de inhoud ondersteunen. Het pakket is geen zelfstandige HTML-speler. Externe bronnen kunnen nog een netwerkverbinding nodig hebben.
Bouw verder op de inhoud
-
Een archief bewaren
Bewaar het deck met de bijbehorende bestanden en leg vast welke formaatversies je reader ondersteunt.
-
Decks genereren
Zet inhoud uit een ander systeem om naar slidevelden en valideer het resultaat met de schema's.
-
Een reader bouwen
Begin bij het formaatcontract en gebruik de compatibiliteitseisen om af te bakenen wat je implementatie ondersteunt.
Versies, licenties en compatibiliteit
- Versies
- Envelopversie 1; contentschemaversie 15. Deze versies beschrijven verschillende delen van het formaat.
- Licenties
- De core-documenten
deck-format.mdendeck-bundle-format.mdvallen onder CC0-1.0. Die licentie geldt niet voor elke pagina in deze sectie. Deckyard, de referentie-implementatie, heeft een MIT-licentie. - Mediatype
-
application/vnd.deckyard.deckidentificeert het pakket. Registratie bij IANA legt het mediatype vast; ze certificeert geen compatibiliteit. Het registratieformulier - Compatibiliteit
- De conformancepagina beschrijft de eisen aan readers en renderers, inclusief de afhandeling van onbekende inhoud.