From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sun, 2 Apr 2023 15:58:25 +0000 (+0100)
Subject: source-info.txt: add some docs about documenting commodities
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=commitdiff_plain;ds=sidebyside;h=396999fb9191b7f5ac9ef4d1e7af928df8536c81;p=ypp-sc-tools.db-live.git

source-info.txt: add some docs about documenting commodities
---

diff --git a/yarrg/source-info.txt b/yarrg/source-info.txt
index 331a7ed..aa5593d 100644
--- a/yarrg/source-info.txt
+++ b/yarrg/source-info.txt
@@ -45,6 +45,19 @@ commodclasses
  *enamel
  *forageables
 
+# Commodities are defined in `commods` sections
+# Each line is
+#  <name> <facts>
+# and the <facts> can be
+#  <mass>kg
+#  <volume>l
+#  *<class> (see commodclasses, above)
+#  @<sort-number>    sort order value, for where in the commods list it goes
+#  @<sort-number>+   sort order value; 10x line number is added
+# The <name> can contain `%<reference>` which is then defined in
+# a `%<reference>` section.
+# Volume defaults to 1l.
+
 commods
  kraken's blood		1kg		*dye			@105
  %d dye			1kg		*dye			@0