This repository has been archived on 2024-07-04. You can view files and clone it, but cannot push or open issues or pull requests.
worblehat-old/cli/commit-file-format.txt
2011-10-09 13:21:46 +00:00

71 lines
2.0 KiB
Plaintext

Filformatet som forventes av 'commit'-kommandoen, og som skrives ut av
kommandoen 'suggest-book-data', samt av andre kommandoer når man gir
opsjonen --commit-format
En linje som starter med '#' er en kommentar.
Filen består av ett eller flere avsnitt. En blank linje indikerer
nytt avsnitt. Hvert avsnitt beskriver én ting som skal gjøres. De
mulige tingene å gjøre er: legge inn ny bok eller forfatter, endre en
eksisterende bok eller forfatter, slette en bok eller forfatter.
Hvert avsnitt har en samling felter med tilhørende verdier. Et felt
skrives med feltnavn, kolon, verdi, newline. Hvis verdien skal bestå
av flere linjer, brukes whitespace (minst ett mellomrom eller en tab)
på begynnelsen av hver ekstra linje. Whitespace (inkludert newline)
mellom kolonet og verdien ignoreres. Whitespace på slutten av linjer
ignoreres. Whitespace på begynnelsen av fortsettelseslinjer fjernes i
verdien som lagres, men newline-ene beholdes.
Eksempler på felter:
title: Foo Bar
description:
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
In ut est ac ante aliquam dictum. Nulla facilisi. Cras vel
lectus mauris. In nec convallis mauris.
Hvert avsnitt må inneholde feltet 'action', som beskriver hva som skal
gjøres. De mulige verdiene for action-feltet er:
new-book
edit-book
delete-book
new-person
edit-person
delete-person
new-category
edit-category
delete-category
Eksempler:
action: new-book
isbn: 4325463287546
title: Foo Bar
subtitle: Baaaz
category: matematikk
persons:
author rjh
author oo
illustrator ko
publisher: Foo Publishing
published_year: 2010
edition: 1
pages: 420
series:
description:
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
In ut est ac ante aliquam dictum. Nulla facilisi. Cras vel
lectus mauris. In nec convallis mauris.
picture:
thumbnail:
references:
url http://example.org/
wikipedia http://en.wikipedia.org/wiki/FooBar
action: edit-category
id: matematikk
name: Matematikk
placement: T10 T11 T12