ВведениеВEmacsWikiMode

Что такое Emacs-Wiki

Emacs-Wiki позволяет создавать и использовать гиперссылки и несложное форматирование в простых текстовых файлах, а также публиковать тексты в формате HTML.

Вводя слово в СмешанномРегистре (также известном как CamelCaps) вы создаете гиперссылку на документ (файл) с таким названием. Нажатие Enter когда курсор стоит на таком названии приводит к созданию файла с таким именем или открытию этого файла, если он уже существует.

Разметка, используемая в Emacs-Wiki, довольно проста для людей, знакомых с Emacs’ом. Краткую справку по разметке можно получить нажав C-h v emacs-wiki-publishing-markup при включенном режиме Emacs-Wiki (т.е. находясь в одном из Wiki-файлов). Или можно обратиться к системе Info (C-h i) и найти там руководство по Emacs-Wiki.

Сводка команд

Краткая сводка клавиатурных команд, доступных в режиме Emacs-Wiki:

C-c C-a
Перейти к списку всех Wiki-страниц.
C-c C-b
Показать все страницы, которые ссылаются на текущую.
C-c C-s
Поиск слова на ваших Wiki-страницах.
C-c C-f
Открыть другую Wiki-страницу. Запрашивает имя файла.
C-c C-l
Переключает подсветку/обновляет текущий буфер.
C-c C-p
Публикует Wiki-страницы, которые изменились со времени предыдущей публикации.
C-c C-r
Переименовать ссылку под курсором.
C-c C-e
Редактировать ссылку под курсором.
C-c C-v
Сменить Wiki-проект.
C-c C-D
Удалить Wiki-ссылку под курсором. Эта возможность доступна только под X.
C-c =
Сравнить текущую страницу с последней резервной копией (Diff).
TAB
Перейти на следующую ссылку.
S-TAB
Перейти на предыдущую ссылку.

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

Абзацы

Одна или более пустых строк трактуются как разделитель абзацев.

Центрирование и цитаты

Строка, начинающаяся с шести или более позиций пустого пространтства, т.е. с пробелов или табуляций (одна табуляция, как обычно, равна восьми пробелам) задает центрированный абзац. (M-s центрирует строку в Emacs).

Строка, начинающаяся с пробелов (количеством, меньшим шести) обозначает цитируемый абзац (blockquote).

Стихи

Каждая строка строфы предваряется символом “больше”:

    > Я помню чудное мгновенье:
    > Передо мной явилась ты,
    > Как мимолетное виденье,
    > Как гений чистой красоты.

Также можно использовать тег <verse>:

    <verse>
    Я помню чудное мгновенье:
    Передо мной явилась ты,
    Как мимолетное виденье,
    Как гений чистой красоты.
    </verse>

Буквальное воспроизведение

HTML-теги &lt;PRE&gt;, &lt;VERBATIM&gt; и &lt;EXAMPLE&gt; могут быть полезны. :)

Заголовки

    * Первый уровень (части)
    ** Второй уровень (главы)
    *** Третий уровень (подглавы)

Звездочки должны быть в начале строки, после них должен быть пробел.

Шрифты

    *emphasis - курсив*
    **strong emphasis - жирный**
    ***very strong emphasis - жирный курсив***
    _подчеркивание_
    <code>печатная машинка (буквальный)</code>

Списки

Ненумерованный список задается так:

    - Вариант раз
    - Вариант два
    - Вариант три

Нумерованный список задается так:

    1. Вариант раз
    2. Вариант два
    3. Вариант три

Пробелы после дефиса или цифры необходимы.

Вложенные списки отсутствуют. Но можно использовать HTML-теги, если они так уж необходимы:

    - Hello
      <ul>
      <li>There
      <li>My friend
      </ul>
    - More items follows..

Ссылки и якоря

Обычные ссылки на другие Wiki-страницы, как уже было сказано, задаются просто в виде имени страницы в СмешанномРегистре.

Когда вы начинаете строку с “#anchor”, где anchor – любое слово (последовательность символов, не содержащая пробелов), вы определяете якорь в этом месте. Этот якорь не будет отображаться в готовом HTML, но вы сможете использовать его чтобы сделать ссылку на эту часть документа из этого же или другого документа: <nop>WikiName#anchor.

Обычный адрес (URL) преобразуется в ссылку. Если это ссылка на изображение, то данное изображение будет вставлено в текст посредством IMG тега.

Кроме обычных ссылок в СмешанномРегистре Emacs-Wiki также поддерживает расширенные ссылки:

[[ссылка][текст ссылки]]

Например:

[[WelcomePage#credits][Авторы]]

Расширенная ссылка всегда преобразуется в ссылку, независимо от того, как она выглядит.

Таблицы

Существует две поддерживаемые разновидности разметки страниц. Если доступен table.el Такааки Ота, просто создайте таблицу, используя его пакет (Подробнее см. ТабличныйРежим).

Если table.el не доступен, тогда вы можете пользоваться только простой разметкой.

Атрибуты таблицы содержатся в emacs-wiki-table-attributes.

Синтаксис разметки следующий:

Двойные вертикальные линии || разделяют || ячейки заголовка
Одинарные линии | разделяют ячейки | тела таблицы
И еще | немного | данных
Тройные ||| разделяют ячейки ||| "подвала" таблицы

Остальная рзметка абзацев работает и для таблиц, т.е. шесть и более пробелов в начале первой строки центрируют таблицу, а от одного до шести – задают blockquote.

Специальная разметка

&lt;nop&gt; перед словом в CamelCaps отменяет его интерпретацию как ссылки на Wiki-страницу.

Чтобы отменить интерпретацию Emacs-Wiki можно использовать тег &lt;nowiki&gt;

Горизонтальная линия: четыре дефиса от начала строки:

----

Сноски

Сноска задается числом в квадратных скобках сразу после слова[1]

Footnotes:

[1] Сноски определяются тем же номером в квадратных скобках, стоящим в начале строки. Для создания сносок по ходу набора текста очень удобно использовать команду C-c ! a режима footnote-mode. Используйте C-x C-x чтобы вернуться потом из текста сносок к тому месту в тексте, откуда была создана последняя сноска.

Конвертирование в красивый HTML

Emacs-Wiki позволяет получать красиво оформленный HTML из страничек.

Чтобы сгенерировать HTML для текущей страницы нужно выполнить команду M-x emacs-wiki-publish-this-page. HTML-файл с тем же именем будет записан в каталог ~/WebWiki.

Команда emacs-wiki-publish генерирует HTML-код для всех страниц, а команда emacs-wiki-publish-index генерирует индекс всех страниц.