Загрузка landslide - Загрузка исходного кода landslide

landslide

Другой исходный код

1.0.0

Скачать

оползень

Landslide создает слайд-шоу с использованием уценки, ReST или текстиля. Он основан на шаблоне Google html5slides.

Следующая уценка создает это слайд-шоу.

 # Landslide

---

# Overview

Generate HTML5 slideshows from markdown, ReST, or textile.

![python](http://i.imgur.com/bc2xk.png)

Landslide is primarily written in Python, but it's themes use:

- HTML5
- Javascript
- CSS

---

# Code Sample

Landslide supports code snippets

    !python
    def log(self, message, level='notice'):
        if self.logger and not callable(self.logger):
            raise ValueError(u"Invalid logger set, must be a callable")

        if self.verbose and self.logger:
            self.logger(message, level)

Требования

python и следующие модули:

jinja2
pygments для окраски синтаксиса кодовых блоков

Преобразование разметки

markdown для уценки
docutils для реструктурированного текста
textile для текстиля

Необязательный

watchdog для просмотра/автоматической регенерации с флагом -w
Принц для экспорта PDF

Установка

Установите последнюю стабильную версию Landslide с помощью менеджера пакетов Python, например pip :

 $ pip install landslide

Если вы хотите оставаться на грани:

 $ git clone https://github.com/adamzap/landslide.git
$ cd landslide
$ python setup.py build
$ sudo python setup.py install

Форматирование

Уценка

Исходные файлы Markdown должны иметь суффикс .md , .markdn , .mdwn , .mdown или .markdown
Чтобы создать титульный слайд, отобразите один элемент h1 (например, # My Title ).
Разделяйте слайды горизонтальной линейкой ( --- в уценке), за исключением конца файлов md.
Другие ваши слайды должны иметь заголовок, который отображается в элементе h1 .
Чтобы выделить блоки кода, поместите !lang , где lang — идентификатор поддерживаемого языка pygment, в качестве первой строки с отступом.

Реструктурированныйтекст

Ваши исходные файлы ReST должны иметь суффикс .rst или .rest ( .txt не поддерживается ).
Используйте заголовки для названий слайдов
Разделяйте слайды с помощью горизонтальной линейки ( ---- в RST), за исключением конца файлов RST.

Текстиль

Разделите слайды с помощью --- , как в уценке.

Рендеринг

Запустите landslide slides.md или landslide slides.rst
Наслаждайтесь только что созданной presentation.html

Или получите его в формате PDF, если Prince установлен и доступен в вашей системе:

 $ landslide README.md -d readme.pdf
$ open readme.pdf

Просмотр

Нажмите h чтобы переключить отображение справки.
Нажмите left arrow и right arrow для навигации
Нажмите t , чтобы переключить оглавление презентации. Заголовки слайдов – это ссылки.
Нажмите ESC , чтобы отобразить обзор презентации (Exposé).
Нажмите n чтобы переключить видимость номера слайда
Нажмите b чтобы включить гашение экрана.
Нажмите c чтобы переключить контекст текущего слайда (предыдущий и следующий слайды).
Нажмите e чтобы слайды заполняли все доступное пространство в теле документа.
Нажмите S , чтобы переключить отображение ссылки на исходный файл для каждого слайда.
Нажмите «2», чтобы переключать заметки на слайдах (укажите с помощью макроса .notes).
Нажмите «3», чтобы переключить псевдо-3D-отображение (экспериментально).
Поддерживается масштабирование браузера

Параметры командной строки

С помощью командной строки доступны несколько опций:

 -h, --help            show this help message and exit
-c, --copy-theme      Copy theme directory into current presentation source
                      directory
-b, --debug           Will display any exception trace to stdin
-d FILE, --destination=FILE
                      The path to the to the destination file: .html or .pdf
                      extensions allowed (default: presentation.html)
-e ENCODING, --encoding=ENCODING
                      The encoding of your files (defaults to utf8)
-i, --embed           Embed stylesheet and javascript contents,
                      base64-encoded images in presentation to make a
                      standalone document
-l LINENOS, --linenos=LINENOS
                      How to output linenos in source code. Three options
                      availables: no (no line numbers); inline (inside                       tag); table (lines numbers in another cell, copy-paste
                      friendly)
-o, --direct-output    Prints the generated HTML code to stdout; won't work
                      with PDF export
-q, --quiet           Won't write anything to stdout (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

Конфигурация презентации

Landslide позволяет настроить презентацию с помощью файла конфигурации cfg , что упрощает агрегацию исходных каталогов и их повторное использование в презентациях. Файлы конфигурации Landslide используют синтаксис cfg . Если вы знаете ini -файлы, вы поймете картину. Ниже приведен пример файла конфигурации:

 [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

Не забудьте объявить раздел [landslide] . Все файлы конфигурации должны иметь расширение .cfg.

Чтобы создать презентацию в соответствии с настройками, просто запустите:

 $ cd /path/to/my/presentation/sources
$ landslide config.cfg

Макросы

Вы можете использовать макросы для улучшения презентации:

Примечания

Добавляйте примечания к слайдам, используя ключевое слово .notes: например:

 # My Slide Title

.notes: These are my notes, hidden by default

My visible content goes here

Вы можете переключить отображение заметок, нажав клавишу 2 .

Некоторые другие макросы также доступны по умолчанию: .fx: foo bar добавит классы foo и bar к соответствующему элементу

слайда, упрощая стилизацию вашей презентации с помощью CSS.

QR-коды

Добавьте QR-код в свою презентацию, используя ключевое слово .qr :

 .qr: 450|http://github.com/adamzap/landslide

Заметки докладчика

Вы также можете добавить заметки докладчика к каждому слайду, добавив к содержимому слайда заголовок «Заметки докладчика». Нажмите клавишу «p», чтобы открыть режим докладчика.

Регистрация макросов

Макросы используются для преобразования HTML-содержимого слайда.

Вы можете зарегистрировать свои собственные макросы, создав производные landslide.macro.Macro , реализовав process(content, source=None) и вернув кортеж, содержащий измененное содержимое и некоторые классы CSS, которые вы, возможно, захотите добавить на слайд

элемент. Например:

 !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()

Это отобразит любой слайд, как показано ниже:

 !html

  foo
  
    my slide contents
    plop

Расширенное использование

Настройка пользовательского файла назначения

 $ landslide slides.md -d ~/MyPresentations/presentation.html

Работа с каталогами

 $ landslide slides/

Работа с прямым выводом

 $ landslide slides.md -o | tidy

Использование альтернативной темы оползня

 $ landslide slides.md -t mytheme
$ landslide slides.md -t /path/to/theme/dir

Встраивание изображений в кодировке Base-64

 $ landslide slides.md -i

Экспорт в PDF

 $ landslide slides.md -d presentation.pdf

Включение математической записи

 Note that this require writing the slides in ReST format as well as
using Docutils 0.8 or newer.

$ landslide slides.rst -m

Включение расширений Markdown

См. документацию по доступным расширениям Markdown здесь:

 $ landslide slides.md -x abbr

Тематика

Тема Landslide представляет собой каталог, имеющий следующую простую структуру:

 mytheme/
|-- base.html
|-- css
|   |-- print.css
|   `-- screen.css
`-- js
    `-- slides.js

Если тема не предоставляет файлы HTML и JS, будут использоваться файлы из темы по умолчанию. CSS не является обязательным.

Наконец, вы также можете скопировать весь каталог темы в каталог презентации, передав параметр --copy-theme команде landslide :

 $ landslide slides.md -t /path/to/some/theme --copy-theme

Пользовательские таблицы стилей и Javascripts

Если вы не хотите заморачиваться с созданием собственной темы, вы можете включить в сгенерированную презентацию свои собственные пользовательские файлы CSS и JS.

Эта функция доступна только в том случае, если вы используете файл конфигурации Landslide, установив флаги css и/или js :

 [landslide]
theme  = /path/to/my/beautiful/theme
source = slides.mdown
css =    custom.css
js =     jquery.js
         powerpoint.js

Они свяжут таблицу стилей custom.css и файлы jquery.js и powerpoint.js в разделе HTML-файла презентации.

ПРИМЕЧАНИЕ. Пути к файлам css и js должны указываться относительно каталога, из которого вы запускаете команду landslide .

Публикация вашей презентации в Интернете

Если вы собираетесь опубликовать свою HTML-презентацию в Интернете, вам придется использовать параметр --relative , а также параметр --copy-theme , чтобы все ссылки на ресурсы относились к корню вашей презентации;

 $ landslide slides.md --relative --copy-theme

Таким образом, вам просто нужно будет разместить весь каталог презентаций на веб-сервере. Конечно, для размещения убедительной презентации не требуется ни Python, ни PHP, ни что-либо еще, кроме веб-сервера HTTP (например, Nginx).

Переменные темы

base.html должен быть файлом шаблона Jinja2, в котором вы можете использовать следующие переменные шаблона:

css : содержимое таблицы стилей, доступное с помощью двух клавиш: print и screen , каждая из которых имеет:
- ключ path_url хранящий URL-адрес пути к файлу ресурса
- ключ contents хранящий содержимое актива
js : содержимое javascript, имеющее:
- ключ path_url хранящий URL-адрес пути к файлу ресурса
- ключ contents хранящий содержимое актива
slides : список слайдов, каждый из которых имеет следующие свойства:
- header : заголовок слайда
- content : содержимое слайда
- number : номер слайда
embed : является ли текущий документ автономным?
num_slides : количество слайдов в текущей презентации.
toc : оглавление со списком разделов документа. В каждом разделе доступны следующие свойства:
- title : название раздела
- number : номер слайда раздела.
- sub : подразделы, если есть

Область применения стилей

Чтобы изменить стили представления HTML5, настройте таблицу стилей css/screen.css связанную с используемой вами темой.
Для PDF измените css/print.css