Begynt å beskrive commit-filformatet.
En hel del detaljer mangler ennå, men det bør være mulig å begynne å kode ting basert på det som står der nå.
This commit is contained in:
parent
f76e01a641
commit
65d988cec7
|
@ -0,0 +1,60 @@
|
||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
|
new-person
|
||||||
|
edit-book
|
||||||
|
edit-person
|
||||||
|
delete-book
|
||||||
|
delete-person
|
||||||
|
|
||||||
|
Eksempel:
|
||||||
|
|
||||||
|
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
|
||||||
|
num_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
|
Reference in New Issue