diff options
| author | rsiddharth <rsd@gnu.org> | 2016-05-12 21:41:17 +0000 |
|---|---|---|
| committer | rsiddharth <rsd@gnu.org> | 2016-05-12 21:41:17 +0000 |
| commit | dd1e62e7337ba840ee03586fe62f27e482bb9448 (patch) | |
| tree | 2f6c4d384dba9ac5bc03038226179486e4b632fd | |
| parent | 766122be7fad43d15da069382731aaee6e636a22 (diff) | |
add docs/speakers/index.rst
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/speakers/index.rst | 68 |
2 files changed, 69 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index c3203a8..7bab3e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,3 +7,4 @@ Home <self> install/index + speakers/index diff --git a/docs/speakers/index.rst b/docs/speakers/index.rst new file mode 100644 index 0000000..b67908f --- /dev/null +++ b/docs/speakers/index.rst @@ -0,0 +1,68 @@ +LP speakers +----------- + +LP speakers usage +~~~~~~~~~~~~~~~~~ +:: + + $ lps_gen -sp path/to/lp-speakers.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html + +or:: + + $ lps_gen --speakers path/to/lp-speakers.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html + +LP speakers markdown structure +`````````````````````````````` + +:: + + # Keynote speaker name 1 + +  + + Lorem ipsum dolor sit amet keynote speaker 1 bio; can contain + inline HTML. + + # Keynote speaker name 2 + +  + + Lorem ipsum dolor sit amet keynote speaker 2 bio; can contain + inline HTML. + + ... + + ## Speaker name 1 + +  + + Lorem ipsum dolor sit amet speaker 1 bio; can contain inline HTML. + + ## Speaker name 2 + +  + + Lorem ipsum dolor sit amet speaker 2 bio; can contain inline HTML. + + ... + + +Everything except the speaker name is optional. + +Sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-speakers.md + +Speaker's ID generation ++++++++++++++++++++++++ + +The last name of the speaker is automatically made the ID; if a +speaker' name is "John Hacker", the ID for this speaker will be +``hacker``. + +- If two or more speakers have the same last name, then, the first + speaker will have their last name as their ID and from the second to + the n^th speaker will have their full name as their ID; if "Bill + Hacker" and "Jill Hacker" are two speakers, "Bill" will get + ``hacker`` as his ID and "Jill" will get ``jill_hacker`` as her ID. + +- The IDs are transliterated to ASCII; if a speaker' name is "John + HÖcker", the ID for this speaker will be ``hacker``. |