sandbox/rst2beamer/docs/examples/columns.rst

   1 ===========================
   2 Using columns in rst2beamer
   3 ===========================
   4
   5 Usage
   6 -----
   7
   8 The LaTeX source for the corresponding Beamer example can be produced::
   9
  10         rst2beamer columns.rst columns.tex
  11
  12
  13 Simple columns
  14 --------------
  15
  16 .. r2b-simplecolumns::
  17         :width: 0.95
  18
  19         This is a demonstration of the rst2beamer simple column directive. It
  20         should turn every element underneath it into a column, side by side with
  21         each other.
  22
  23         So here, we should end up with three columns of equal width, occupying 0.95
  24         of the page in total. The 'width' argument is optional and defaults to
  25         0.90.
  26
  27         * A list or image element can be
  28         * a
  29         * column
  30
  31
  32 Containers as columns
  33 ---------------------
  34
  35 .. container:: r2b-simplecolumns
  36
  37         The custom r2b directives won't be recognised by any writer other than
  38         rst2beamer. Therefore, we allow certain containers (which most other
  39         writers should recognise and at worst ignore) to act like column sets.
  40
  41         Any container with the name 'r2b-simplecolumns' or 'r2b-simplecolumns' will
  42         be handled like the simple columns directive.
  43
  44
  45 Explicit columns
  46 ----------------
  47
  48 .. r2b-columnset::
  49         :width: 0.95
  50
  51         .. r2b-column::
  52                 :width: 0.60
  53
  54                 If you insist on setting columns explicitly, you can, grouping multiple
  55                 elements.
  56
  57                 The width of the column set and individual columns can be given. This
  58                 set and column are 0.95 and 0.60 wide respectively.
  59
  60         .. r2b-column::
  61
  62                 Columns not given a width (like this one) share the remainder.
  63
  64
  65 A slide without columns
  66 -----------------------
  67
  68 Just to make sure our "columnization" isn't persistent, this should show up
  69 up as a plain normal slide.
  70
  71 Has it?
  72