pax_global_header 0000666 0000000 0000000 00000000064 12500206157 0014510 g ustar 00root root 0000000 0000000 52 comment=9a70c0f4fd00c17cffbfd0da7ffb87da118ff9b0
landslide-1.1.3/ 0000775 0000000 0000000 00000000000 12500206157 0013451 5 ustar 00root root 0000000 0000000 landslide-1.1.3/.gitignore 0000664 0000000 0000000 00000000276 12500206157 0015446 0 ustar 00root root 0000000 0000000 *.pyc
build
.idea
landslide/.idea
presentation.html
*.pdf
examples/.DS_Store
*.swp
src/landslide.egg-info/
dist/
*.komodoproject
.komodotools
landslide.sublime-project
docs/_build
venv
.tox
landslide-1.1.3/CHANGELOG.md 0000664 0000000 0000000 00000003446 12500206157 0015271 0 ustar 00root root 0000000 0000000 # Changelog
## v1.1.3
- Identify each slide by a numbered class (#171) (dkg)
- Fix theme image embedding regex to grab all images (#170)
- Fix blockquote font size for rst (#161)
- Fix display of RST image target links (#87)
- Fix relative path generation (#147)
- Add command line option for print version (#135)
- Add use of '---' as a slide separator to textile files (#163)
- README improvements (#88 and #101)
- Improve image path regex and replacement (#177)
## v1.1.2
- Add support for Python 3
- Allow support for copy_theme argument in CFG files (#139) (syscomet)
- Improve MathJax rendering for Markdown files
- Support math output (#144) (davidedelvento)
- Allow presenter notes in slides with no heading in RST files (#141) (regebro)
- And more...
## v1.1.1
### Fixes
- Don't accidentally require watchdog (#134)
## v1.1.0
### Major Enhancements
- Add CHANGELOG
- Add "ribbon" theme from "shower" presentation tool (#129) (durden)
- Add `-w` flag for watching/auto-regenerating slideshow (#71, #120) (jondkoon)
### Minor Enhancements
- Supress ReST rendering errors
- CSS pre enhancements (#91) (roktas)
- Add an example using presenter notes (#106) (netantho)
- Run macros on headers also, to embed images (#74) (godfat)
- Allow PHP code snippets to not require
tag); table (lines numbers in another cell, copy-paste
friendly)
-o, --direct-output Prints the generated HTML code to stdin; won't work
with PDF export
-q, --quiet Won't write anything to stdin (silent mode)
-r, --relative Make your presentation asset links relative to current
pwd; This may be useful if you intend to publish your
html presentation online.
-t THEME, --theme=THEME
A theme name, or path to a landlside theme directory
-v, --verbose Write informational messages to stdin (enabled by
default)
-w, --watch Watch the source directory for changes and
auto-regenerate the presentation
-x EXTENSIONS, --extensions=EXTENSIONS
Comma-separated list of extensions for Markdown
-m, --math-output Enable mathematical output using mathjax
# Presentation Configuration
Landslide allows to configure your presentation using a `cfg` configuration
file, therefore easing the aggregation of source directories and the reuse of
them across presentations. Landslide configuration files use the `cfg` syntax.
If you know `ini` files, you get the picture. Below is a sample configuration
file:
[landslide]
theme = /path/to/my/beautiful/theme
source = 0_my_first_slides.md
a_directory
another_directory
now_a_slide.markdown
another_one.rst
destination = myWonderfulPresentation.html
css = my_first_stylesheet.css
my_other_stylesheet.css
js = jquery.js
my_fancy_javascript.js
relative = True
linenos = inline
Don't forget to declare the `[landslide]` section. All configuration files
must end in the .cfg extension.
To generate the presentation as configured, just run:
$ cd /path/to/my/presentation/sources
$ landslide config.cfg
# Macros
You can use macros to enhance your presentation:
## Notes
Add notes to your slides using the `.notes:` keyword, eg.:
# My Slide Title
.notes: These are my notes, hidden by default
My visible content goes here
You can toggle display of notes by pressing the `2` key.
Some other macros are also available by default: `.fx: foo bar` will add the
`foo` and `bar` classes to the corresponding slide `
` element, easing
styling of your presentation using CSS.
## QR Codes
Add a QR Code to your presentation by using the `.qr` keyword:
.qr: 450|http://github.com/adamzap/landslide
# Presenter Notes
You can also add presenter notes to each slide by following the slide content
with a heading entitled "Presenter Notes". Press the 'p' key to open the
presenter view.
# Registering Macros
Macros are used to transform the HTML contents of your slide.
You can register your own macros by creating `landslide.macro.Macro` derived
classes, implementing a `process(content, source=None)` method and returning
a tuple containing the modified contents and some css classes you may be
wanting to add to your slide `
` element. For example:
!python
import landslide
class MyMacro(landslide.Macro):
def process(self, content, source=None):
return content + '
plop
', ['plopped_slide']
g = landslide.generator.Generator(source='toto.md')
g.register_macro(MyMacro)
print g.render()
This will render any slide as below:
!html
foo
my slide contents
plop
# Advanced Usage
## Setting Custom Destination File
$ landslide slides.md -d ~/MyPresentations/presentation.html
## Working with Directories
$ landslide slides/
## Working with Direct Output
$ landslide slides.md -o | tidy
## Using an Alternate Landslide Theme
$ landslide slides.md -t mytheme
$ landslide slides.md -t /path/to/theme/dir
## Embedding Base-64-Encoded Images
$ landslide slides.md -i
## Exporting to PDF
$ landslide slides.md -d presentation.pdf
## Enabling mathematical notation
Note that this require writing the slides in ReST format as well as
using Docutils 0.8 or newer.
$ landslide slides.rst -m
## Enabling Markdown Extensions
See documentation on available Markdown extensions
[here](https://pythonhosted.org/Markdown/extensions/index.html):
$ landslide slides.md -x abbr
# Theming
A Landslide theme is a directory following this simple structure:
mytheme/
|-- base.html
|-- css
| |-- print.css
| `-- screen.css
`-- js
`-- slides.js
If a theme does not provide HTML and JS files, those from the default theme
will be used. CSS is not optional.
Last, you can also copy the whole theme directory to your presentation one by
passing the `--copy-theme` option to the `landslide` command:
$ landslide slides.md -t /path/to/some/theme --copy-theme
# User stylesheets and Javascripts
If you don't want to bother making your own theme, you can include your own
user css and js files to the generated presentation.
This feature is only available if you use a landslide configuration file, by
setting the `css` and/or `js` flags:
[landslide]
theme = /path/to/my/beautiful/theme
source = slides.mdown
css = custom.css
js = jquery.js
powerpoint.js
These will link the ``custom.css`` stylesheet and both the ``jquery.js`` and
``powerpoint.js`` files within the ```` section of the presentation html
file.
**NOTE:** Paths to the css and js files must be relative to the directory
you're running the ``landslide`` command from.
# Publishing your Presentation Online
If you intend to publish your HTML presentation online, you'll have to use the
`--relative` option, as well as the `--copy-theme` one to have all asset links
relative to the root of your presentation;
$ landslide slides.md --relative --copy-theme
That way, you'll just have to host the whole presentation directory to
a webserver. Of course, no Python nor PHP nor anything else than a HTTP
webserver (like Apache) is required to host a landslide presentation.
[Here's an example][akei-pres].
[akei-pres]: http://www.akei.com/presentations/2011-Djangocong/index.html
# Theme Variables
The `base.html` must be a [Jinja2 template file][jinja-docs] where you can
harness the following template variables:
- `css`: the stylesheet contents, available via two keys, `print` and `screen`,
both having:
- a `path_url` key storing the url to the asset file path
- a `contents` key storing the asset contents
- `js`: the javascript contents, having:
- a `path_url` key storing the url to the asset file path
- a `contents` key storing the asset contents
- `slides`: the slides list, each one having these properties:
- `header`: the slide title
- `content`: the slide contents
- `number`: the slide number
- `embed`: is the current document a standalone one?
- `num_slides`: the number of slides in current presentation
- `toc`: the Table of Contents, listing sections of the document. Each section
has these properties available:
- `title`: the section title
- `number`: the slide number of the section
- `sub`: subsections, if any
[jinja-docs]: http://jinja.pocoo.org/2/documentation/templates
# Styles Scope
- To change HTML5 presentation styles, tweak the `css/screen.css` stylesheet
bundled with the theme you are using
- For PDF, modify the `css/print.css`
# Authors
## Original Author and Development Lead
- Adam Zapletal (adamzap@gmail.com)
## Co-Author
- Nicolas Perriault (nperriault@gmail.com)
## Contributors
See https://github.com/adamzap/landslide/contributors
## Base Template Authors and Contributors (html5-slides)
- Marcin Wichary (mwichary@google.com)
- Ernest Delgado (ernestd@google.com)
- Alex Russell (slightlyoff@chromium.org)
landslide-1.1.3/docs/ 0000775 0000000 0000000 00000000000 12500206157 0014401 5 ustar 00root root 0000000 0000000 landslide-1.1.3/docs/Makefile 0000664 0000000 0000000 00000010772 12500206157 0016050 0 ustar 00root root 0000000 0000000 # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make ' where is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Landslide.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Landslide.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Landslide"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Landslide"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
make -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
landslide-1.1.3/docs/conf.py 0000664 0000000 0000000 00000015672 12500206157 0015713 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
#
# Landslide documentation build configuration file, created by
# sphinx-quickstart on Sun Feb 27 10:01:49 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../src'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Landslide'
copyright = u'2011, Adam Zapletal, Nicolas Perriault'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.8'
# The full version, including alpha/beta/rc tags.
release = '0.8.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'Landslidedoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Landslide.tex', u'Landslide Documentation',
u'Adam Zapletal, Nicolas Perriault', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'landslide', u'Landslide Documentation',
[u'Adam Zapletal, Nicolas Perriault'], 1)
]
landslide-1.1.3/docs/index.rst 0000664 0000000 0000000 00000005236 12500206157 0016250 0 ustar 00root root 0000000 0000000 Landslide's documentation
=========================
Landslide_ is a command-line based presentation generator relying on Web standards (html, javascript, css) and some Python_ libraries such as Jinja2_, Pygments_, docutils_ and Markdown_.
Installation
------------
Landslide requires Python_ v2.5 minimum and these dependencies installed:
* The Jinja2_ template engine
* Pygments_ for code syntax highlighting
One of the syntax handlers above:
* The Markdown_ python library if you intend to write your slides contents using the Markdown_ syntax
* or the docutils_ package if you rather prefer using reStructuredText_.
The easiest way to install Landslide_ is using Pip_::
$ pip install landslide
Alternatively, you can use easy_install_::
$ easy_install landslide
If you rather want to stay `on the edge`_::
$ git clone https://github.com/n1k0/landslide.git
$ cd landslide
$ python setup.py build
$ sudo python setup.py install
Basic Usage
-----------
Using the Markdown_ syntax
~~~~~~~~~~~~~~~~~~~~~~~~~~
* Your Markdown source files must be suffixed by ``.md``, ``.markdn``, ``.mdown`` or ``.markdown``
* To create a title slide, render a single h1 element (eg. ``# My Title``)
* Separate your slides with a horizontal rule (``---`` in markdown) except at the end of markdown files
* Your other slides should have a heading that renders to an ``
`` or ``
`` element
* To highlight blocks of code, put ``!{lang}`` where ``{lang}`` is the pygment supported language identifier as the first indented line
Here's a sample presentation based on Markdown::
# My Presentation Heading
---
## My First Slide Title
With some contents
---
## My Second Slide Title
With some contents
Using the reStructuredText_ syntax
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Bar
API Documentation
-----------------
Generator
~~~~~~~~~
.. automodule:: landslide.generator
:members:
Macros
~~~~~~
.. automodule:: landslide.macro
:members:
Parser
~~~~~~
.. automodule:: landslide.parser
:members:
Utils
~~~~~
.. automodule:: landslide.utils
:members:
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. links
.. _docutils: http://docutils.sourceforge.net/
.. _easy_install: http://packages.python.org/distribute/easy_install.html
.. _Jinja2: http://jinja.pocoo.org/
.. _Landslide: https://github.com/n1k0/landslide
.. _Markdown: http://daringfireball.net/projects/markdown/
.. _on the edge: https://github.com/n1k0/landslide/commits/master/
.. _Pip: http://pip.openplans.org/
.. _Pygments: http://pygments.org/
.. _Python: http://python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html landslide-1.1.3/examples/ 0000775 0000000 0000000 00000000000 12500206157 0015267 5 ustar 00root root 0000000 0000000 landslide-1.1.3/examples/_assets/ 0000775 0000000 0000000 00000000000 12500206157 0016730 5 ustar 00root root 0000000 0000000 landslide-1.1.3/examples/_assets/landscape.jpg 0000664 0000000 0000000 00000145410 12500206157 0021371 0 ustar 00root root 0000000 0000000 JFIF xPhotoshop 3.0 8BIM ?Z %G > 20101214? 0907407 20101214<