summaryrefslogtreecommitdiffstats
path: root/example/demo.rst
blob: c105e7de751e1266c2505d43b9e120fb79037360 (plain)
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
.. This is an RST comment.
   The following directives, when used at the top of the file, set default
   values for all slides:

   This sets the transition style.  Values are: 'dissolve', 'pan',
   'tilt', or 'cut'.  The optional argument of 'duration' sets the
   duration of the transition in seconds (0.4 seconds by default).
   The same syntax may be used within a slide to override thes
   transition for that slide alone.

   .. transition:: dissolve
      :duration: 0.4

   This disables display of the title.  Each slide must still have a
   title, and it will be used by the presenter console, but it will
   not be displayed on the slide.  The same syntax may be used within
   a slide to hide the title of that individual slide.

   .. hidetitle::

.. Slides are defined one at a time by starting a new top-level
   section:

Presentty
=========
.. container:: handout

   Content that is placed in a container called "handout" will not be
   displayed with the slides, but will be displayed on the presenter's
   console.

Presentty is a console presentation system based where slides are
authored in reStructuredText.

Bullet Lists
============
It is able to display lists of items:

* Pork

  * Eastern North Carolina
  * Lexington

* Ribs
* Brisket


Progressive Display
===================
Bullet lists may include a *progressive* display:

.. container:: progressive

  * Red Leicester
  * Tilsit
  * Caerphilly


Table
=====

=== ===
 p  !p
=== ===
 T   F
 F   T
=== ===

Dissove Transition
==================
Transitions may be "dissolve," where one slide cross-fades into the next...

Pan Transition
==============
.. transition:: pan

...or "pan," where the slides appear horizontally adjacent and move
right to left...

Tilt Transition
===============
.. transition:: tilt

...or "tilt," where the slides appear vertically adjacent and move
bottom to top...

Cut Transition
==============
.. transition:: cut

...or "cut," where they abruptly change from one to the next.

Syntax Highligting
==================
Pygments is used to provide syntax highlighting of code in almost any
language:

.. code:: python

  class UrwidTranslator(nodes.GenericNodeVisitor):
    def depart_Text(self, node):
        if self.stack and isinstance(self.stack[-1], 'string'):
            # a comment
            if self.attr:
                t = (self.attr[-1], node.astext())
            else:
                t = node.astext()
            self.stack[-1].append(t)
    visit_literal_block = visit_textelement

Cowsay
======
.. cowsay:: Presentty is a console-based presentation program where
            reStructuredText is used to author slides.

| If cowsay is installed, it can easily
| be used to display text.

Figlet
======
.. container:: handout

   Cowsay and figlet are non-standard directives and will not appear
   if the RST file is rendered with a program other than presentty.
   If you want to ensure that the content appears in all forms, you
   may wish to run the respective commands manually and copy the
   output into a quoted block in the RST file.

.. figlet:: FIGLET

| If figlet is installed, it can be
| used to provide large text.

ANSI Art
========
.. hidetitle::
.. container:: handout

   Note that the ansi directive is specific to presentty, and so if an
   RST file that includes it is rendered with another program,
   included ANSI files will not appear.

.. ansi:: ansi.ans

Images
======
.. container:: handout

   The standard sphinx image directive can be used to include bitmap
   images (such as JPEG or PNG files) which will be automatically
   converted to ANSI art for display.  This feauter requires that PIL
   or Pillow (Python Image Library) and jp2a be installed.

.. image:: gg.jpg

"Golden Gate Bridge" by Kevin Cole (CC-BY: https://flic.kr/p/7L2Rdu)