summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrsiddharth <rsd@gnu.org>2016-05-11 04:42:33 +0000
committerrsiddharth <rsd@gnu.org>2016-05-11 04:42:33 +0000
commitde31e4742f878bd02018893bb9af2f09ade52c90 (patch)
tree4ed72f7464ff17aae9da2b0a102c58bb07b197ae
parentddd7c33e8e488ebfb163cef2ebd2ef6cbc9f6dc0 (diff)
update README.rst
- Add "Speaker TBA" section - Add "Description TBA" section Addresses issue #4.
-rw-r--r--README.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index fcf47ad..4873719 100644
--- a/README.rst
+++ b/README.rst
@@ -170,6 +170,14 @@ Sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-sess
Special cases
+++++++++++++
+Speaker TBA
+...........
+
+When the speaker information for a session is not yet available put
+``SpeakerTBA`` as the placeholder in the line that usually contains
+the speaker information; the rendered HTML will not have speaker
+information for sessions that have ``SpeakerTBA``.
+
Room TBA
........
@@ -178,6 +186,15 @@ placeholder in the line that usually contains the room number; the
rendered HTML will not have the room number for sessions that have
``RoomTBA``.
+Description TBA
+...............
+
+When the description for session is not yet available put ``DescTBA``
+as the placeholder; the rendered HTML will not have the description
+for sessions that have ``DescTBA``.
+
+Sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-sch-tba.md
+
Sessions only schedule
......................