libreplanet schedule generator - ricketyspace.net/lpschedule-generator
git clone git://git.ricketyspace.net/lpschedule-generator.git
Log | Files | Refs

commit 2872337665a0f9e9d9f61ed47bdb44bebcfbb48a
parent 4a39bc9e5df1997894717c81d602f6144314f2a5
Author: rsiddharth <rsd@gnu.org>
Date:   Sat, 13 Feb 2016 21:14:31 -0500

README.rst: Added "Auto-linking speakers names"

sub-section under "LP schedule" section.

Addresses issue #7.

README.rst | 27+++++++++++++++++++++++++++
lps_gen.py | 2+-
2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.rst b/README.rst @@ -122,6 +122,33 @@ Session structure:: Sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-sch.md + +Auto-linking speaker names +++++++++++++++++++++++++++ + +Speakers in the schedule MD can be auto-linked to speakers' page by +marking them up like this ``[John Hacker]()`` + +The script converts: + +- ``[John Hacker]()`` to ``<a href="speakers.html#hacker">John + Hacker</a>`` if John Hacker's bio is available in the speakers' page. + +- ``[John Hacker]()`` to ``John Hacker`` if John Hacker's bio is not + available in the speakers' page. In this case, the script also appends + ``John Hacker`` name in the ``speakers.noids`` file. + + The ``speakers.noids`` file contains a list of speakers who were + auto-linked in the schedule MD but who's bio is not (yet) available + in the speakers' page. + +For auto-linking speakers, the script uses the ``speakers.ids`` file; +this file is written to the disk after generating the the speakers' +page from MD. Generate the speakers' page before generating the +schedule page for auto-linking to work. + +Sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-sessions-autolink.md + Special cases +++++++++++++ diff --git a/lps_gen.py b/lps_gen.py @@ -31,7 +31,7 @@ from jinja2.exceptions import TemplateNotFound from mistune import Renderer, Markdown from unidecode import unidecode -__version__ = '0.3.0.dev1' +__version__ = '0.3.0.dev2' # unicode magic reload(sys)