Skip to content

Commit

Permalink
Added weekend events to the example
Browse files Browse the repository at this point in the history
  • Loading branch information
jwodder committed Apr 16, 2019
1 parent 3ae4387 commit b5b4a95
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 8 deletions.
20 changes: 13 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ Usage
pdfschedule [<OPTIONS>] [<infile> [<outfile>]]

Input — formatted as described below under "`Input Format <input_format_>`_" —
is read from ``infile`` (or standard input if no file is specified), and the
resulting PDF is written to ``outfile`` (or standard output if no file is
is read from ``<infile>`` (or standard input if no file is specified), and the
resulting PDF is written to ``<outfile>`` (or standard output if no file is
specified).


Expand All @@ -53,8 +53,9 @@ Options
the text font. By default, all text is typeset in Helvetica.

- ``-f <size>``, ``--font-size <size>`` — Set the size of the font used for
event information to ``size`` (default 10). The names of the days of the
week are typeset at ``size * 1.2``; the times of day are at ``size / 1.2``.
event information to ``<size>`` (default 10). The names of the days of the
week are typeset at ``<size> * 1.2``; the times of day are at ``<size> /
1.2``.

- ``-M``, ``--start-monday`` — Use Monday as the first day of the week instead
of Sunday.
Expand All @@ -64,7 +65,7 @@ Options
"landscape mode."

- ``-s <factor>``, ``--scale <factor>`` — Divide the length of each side of the
table by ``factor``. Without this option, the table fills the whole page,
table by ``<factor>``. Without this option, the table fills the whole page,
except for a one-inch margin on each side.

- ``-T``, ``--no-times`` — Do not show the times for each hour line.
Expand All @@ -86,7 +87,8 @@ represents a single weekly event and must contain the following keys:

``days``
The days of the week on which the event occurs, specified as a string of one
or more of the following abbreviations in any order:
or more of the following abbreviations in any order (optionally with
intervening whitespace and/or commas):

=================================== =========
Abbreviation Day
Expand Down Expand Up @@ -124,7 +126,7 @@ The following input file::
- name: |
Exercise class
(The one on Main Street)
days: W
days: M, W, F
time: 17:00 - 18:00

- name: Have they brought back my favorite show yet?
Expand All @@ -135,6 +137,10 @@ The following input file::
days: F
time: 22-23.59

- name: Sleep in
days: SatSun
time: 7-12

produces (using the default options) an output file that looks like this:

.. image:: https://github.com/jwodder/schedule/raw/master/examples/example01.png
Binary file modified examples/example01.pdf
Binary file not shown.
Binary file modified examples/example01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion examples/example01.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- name: |
Exercise class
(The one on Main Street)
days: W
days: M, W, F
time: 17:00 - 18:00

- name: Have they brought back my favorite show yet?
Expand All @@ -19,3 +19,7 @@
- name: Poor decisions
days: F
time: 22-23.59

- name: Sleep in
days: SatSun
time: 7-12
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ url = https://github.com/jwodder/schedule
keywords =
pdf
schedule
week

classifiers =
Development Status :: 4 - Beta
Expand Down

0 comments on commit b5b4a95

Please sign in to comment.