summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 20fc4794f322ad3f478581e88fc6f906b430fc78 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
LibrePlanet schedule generator
==============================

Installation
------------

On a Debian based distribution, do::

  # aptitude install virtualenv python-setuptools

Install globally
~~~~~~~~~~~~~~~~

::

   $ sudo pip install lpschedule-generator


Install locally using virtualenv (Recommended)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Make a separate ``lpschedule-generator`` directory and initialize the
virtual environment in it::

  $ mkdir lpschedule-generator
  $ cd lpschedule-generator

  $ virtualenv .
  $ source bin/activate

Install ``lpschedule-generator`` inside this directory using ``pip``::

  $ pip install lpschedule-generator

Activating virtual environment
``````````````````````````````

Always activate the virtual environment before using the ``lps_gen``
command::

   $ cd path/to/lpschedule-generator
   $ source bin/activate


LP schedule
-----------

LP schedule usage
~~~~~~~~~~~~~~~~~
::

   $ lps_gen -s path/to/lp-sch.jinja2 path/to/lp-sch.md > path/to/program-schedule.html

or::

  $ lps_gen --schedule path/to/lp-sch.jinja2 path/to/lp-sch.md > path/to/program-schedule.html


LP schedule markdown structure
``````````````````````````````

Overall structure::

   ## Day 1

   ### Timeslot 1

   #### Session 1

   #### Session 2

   ...

   ### Timeslot 2

   #### Session 1

   #### Session 2

   ...

   ## Day 2

   ### Timeslot 1

   #### Session 1

   #### Session 2

   ...

Session structure::

  #### Fork and ignore: fighting a GPL violation by coding instead

  [Bradley Kuhn][kuhn], [Karen Sandler][sandler]

  Room 32-155

  Typically, GPL enforcement activity involves copyright infringement
  actions which compel license violators to correct errors in their
  GPL compliance, defending the policy goals of the GPL: the rights of
  developers and users to copy, share, modify and redistribute.

  While traditional enforcement is often undeniably necessary for
  embedded electronics products, novel approaches to GPL violations
  are often possible and even superior for more traditional software
  distributions.

  Recently, [Software Freedom Conservancy][sfc] engaged in an
  enforcement action whereby, rather than fight the violator in court,
  we instead provided resources and assistance to a vetted
  GPL-compliant fork of a violating codebase.

  This talk discusses which scenarios make this remedy optimal and the
  lessons learned. The talk includes some licensing and technical
  content about vetting the licensing information of codebases.

  [kuhn]: https://libreplanet.org/YEAR/path/to/speakers.html#kuhn
  [sandler]: https://libreplanet.org/YEAR/path/to/speakers.html#sandler
  [sfc]: https://sfconservancy.org/

Sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-sch.md

Special cases
+++++++++++++

Room TBA
........

When a room for a session is not yet available put ``RoomTBA`` as the
placeholder in the line that usually contains the room number; the
rendered HTML will not have the room number for sessions that have
``RoomTBA``.

Sessions only schedule
......................

It is possible to have a sessions only schedule. To do this, at the
beginning of the markdown document:

- Add a level two heading (``##``) with one or more whitespaces.
- Add a level three heading (``###``) with one or more whitespaces.

Sessions only sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-sch-sessions-only.md

LP speakers
-----------

LP speakers usage
~~~~~~~~~~~~~~~~~
::

   $ lps_gen -sp path/to/lp-speakers-2016.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html

or::

  $ lps_gen --speakers path/to/lp-speakers-2016.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html

LP speakers markdown structure
``````````````````````````````

::

   # Keynote speaker name 1

   ![Keynote speaker name 1 - Photo](//fsf.org/images/ks1.jpg)

   Lorem ipsum dolor sit amet keynote speaker 1 bio; can contain
   inline HTML.

   # Keynote speaker name 2

   ![Keynote speaker name 2 - Photo](//fsf.org/images/ks2.jpg)

   Lorem ipsum dolor sit amet keynote speaker 2 bio; can contain
   inline HTML.

   ...

   ## Speaker name 1

   ![Speaker name 1 - Photo](//fsf.org/images/s1.jpg)

   Lorem ipsum dolor sit amet speaker 1 bio; can contain inline HTML.

   ## Speaker name 2

   ![Speaker name 2 - Photo](//fsf.org/images/s2.jpg)

   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``.


Source
------

::

   $ git clone https://notabug.org/rsd/lpschedule-generator.git