Вики своими руками

В одном обсуждении я упомянул что пользуюсь markdown и git вместо вики движков и гуглдоков. Следует слегка развернуть мысль.

Обычно, если автор доходит до использования вики, ему нужно одно или два из:
а) Система контроля версий
б) Гипертекст (т.е. линки к другим разделам/статьям)

И хотя вики-движки обе фичи предлагают в наилучшем виде, они все же недотягивают в удобстве использования.
Sublime Text 2 + Markdown Editing

Гипертекст
Итак, Markdown (На самом деле я пользуюсь его расширением, MultiMarkdown) это язык разметки рожденный из идеи что текст в разметке должен быть пригодным к печати как-есть, не выглядя при этом как текст с дополнительными пометками.

Автор языка выбирал максимально интуитивные и читабельные знаки и правила форматирования. Получился эдакий «интуитивный вв-код», чтобы и в блокноте можно было писать, и в формат для публикации перегнать несложно. MultiMarkdown поддерживает: форматирование текста, ссылки, сноски, картинки, таблицы, цитирование и библиографию, типографию, математические формулы, словари и десятки опций экспорта. Если добавить к этому CSS, так еще и визуальное оформление под полным контролем автора.

В блокноте ли писать? На самом деле с маркдаун случилась эдакая микрореволюция в определенных кругах и, теперь, найти себе редактор по душе совершенно не проблема. Лично я предпочитаю Vim, но за легкость в обучении его явно не похвалишь, поэтому на тайтлпике Sublime Text 2 с плагином Markdown Editing — мой второй выбор и, в общем то, один из лучших бесплатных текстовых редакторов в мире. С гиперссылками разобрались.

Система контроля версий
Как и маркдаун, git родился как инструмент для программистов. Но со временем пользу от ad hoc контроля версий в любой папке начали видеть и другие создатели текстового контента. Например гитом пользуются авторы Dungeon World.

Концепция гит несложна, но все затрудняет специфический сленг. Человеческим языком, этот инструмент позволяет сохранять бэкапы содержимого директории, вести историю этих бэкапов, построчно показывать разницу между ними, давать бэкапам человекопонятные имена и, наконец манипулировать их версиями. А что еще любопытнее, гит позволяет асинхронно работать над проектом целому коллективу людей, улаживая конфликты изменений и обеспечивая сетевую синхронизацию.

Таким образом можно хранить всю историю написания книги, с именами «до-коректуры», «предпечать», «релиз» для веховых точек, с ветками «основная» и «альтернативное-описание-дварфов» и все это не будет выглядеть сплошным хаосом.

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

Всë вместе
Ну и наконец, пользуюсь я этим для создания любого текстового контента, обычно статей, модулей, кампаний. Хотя гит и может хранить бинарные файлы (картинки, музыка), я стараюсь от этого воздерживаться.

Маркдаун тексты легко хранить, легко трансформировать, легко выгружать в какой-то там дропбокс. А в Vim еще и, по нажатию клавиши, любое слово превращается в ссылку, второе ее же нажатие переносит в новосозданный документ по этой ссылке — всякая разница с вики-движками совершенно теряется.

Альтернатива
В том же треде я упомянул как альтернативу Scrivener. Этот комбайн вообще все умеет — хранить библиотеку мультимедиа, версировать и форматировать тексты, наполнять комментариями и сортировать по категориям. И Маркдаун он тоже понимает. В общем, создавалась программа специально для написания полноформатных книг.

В минус могу сказать только, что работа в Scrivener поначалу весьма некомфортна, а задуманный автором workflow требует привыкания. Да еще и плохо приспособлен для создания широкого дерева статей и записок. И главное, я не берусь вам передать, насколько меня выбешивает невозможность вытащить из Scrivener-a что-то назад. Картинки для использования в игре приходится собирать в обыкновенной папке, постепенно перенося в библиотеку Roll20.

Обязательная картинка (моя текущая кампания):
Scrivener

Надеюсь что кто-то найдет в этом перечне недостающее ему звено. Очень надеюсь что вдохновленный Коммуниздий запилит на Имке поддержку маркдауна — это так уныло, тянутся к мышке через раз. А может какая-то команда даже начнет публиковать на гитхабе свою книжку.

Не стесняйтесь задавать вопросы.

14 комментариев

avatar
пользуюсь markdown и git вместо вики движков и гуглдоков.

Сразу видно понимающего человека!
avatar
Туда же )
Лично я предпочитаю Vim
avatar
Большое спасибо за интересный пост!

По поводу Scrivener.
Насчёт Scrivener:

Насколько у него жёсткий workflow? Т.е. положим, если я пишу текст в блокноте, храню картинки в bmp и jpg и организую хранение и использование этого всего с помощью проводника, то во многом я сам принимаю решения, каким образом мне организовывать процесс. Мне показалось, что Scrivener скорей сам задаёт порядок работы, именно ради этого его создавали.

Понятно, что карт или там изображений монстров с его помощью не сделаешь — не тот профиль. Но в подготовке игр — возможно ли с его помощью обеспечить игровой процесс всеми необходимыми документами? Там, раздаточными материалами, пользовательскими листами персонажей, шпаргалками по кастомной механике? Насколько далеко простирается их концепция «единственного окна»?

И есть ли у него возможность синхронизации нескольких рабочих мест?
avatar
Скрайвенер сфокусирован на выходном тексте. Ты можешь писать во многих файлах, или одном, но программа ждет от тебя что рано или поздно все что в папке Выход, будет скомпилировано в книгу/сценарий/статью и передано на публикацию. Раздаточные материалы под большим вопросом т.к. вынять из программы можно только текст, и то, только копипастой. Ровно одна папка считается папкой для результата и из нее можно проводить экспорт во всякие пдф.

Что же до шпаргалок, записок, полезных закладок в интернете, хронологии игры, описания НПЦ и локаций, сортировки и категоризации, картинок для вдохновления (тебя, мастера) — это все на ура, см. мой скриншот. Вообще, организационных фич в нем больше чем я когда либо стану использовать. Но, Скрайвенер может хранить все что угодно — для вдохновления автора — но производить в нем можно только текст.

Интерфейс гибкий и, если наловчится, довольно быстрый. Очень удобно на пол-окна открывать заготовку квеста, а во второй половине листать референсные материалы. Вообще, хранение всего в одной «базе данных» (с прозрачным поиском, кстати, по всем файлам) — это то ради чего я решил его попробовать.

Сихнронизация в виде бэкапа проекта в дропбокс. Проект неделим и другими программами не откроешь.
avatar
Спасибо за подробный ответ, многое стало понятным.
Выглядит интересно, но, к сожалению, это пока не моя чашка чаю.
Буду пробовать git.
avatar
Если нужна система контроля версий, я бы посоветовал еще Mercurial. Под винду есть неплохой интерфейс TortoiseHg Workbench. Время освоения с Mercurial, на мой взгляд, меньше, чем с git. Хранить репозитории можно на bitbucket.org, который, в отличии от GitHub, позволяет иметь приватные репозитории бесплатно.
avatar
Поддержу, для tech savvy это скорее вопрос привычки, но новичку hg может показатся легче.

Если же работать из графического интерфейса, так тут вообще-то разницы нет. TortoiseGit так же в наличии ;)

Приватными репозитариями я не пользуюсь. Или все сыро и я вообще ни с кем не делюсь, или все читабельно и мне не жалко его публиковать (тоже, впрочем, нечасто через git). Подозреваю зато что эта фича понравится группам авторов.
avatar
Я для ролевых штук предпочитаю гуглдоки (чаще) и вики (реже), потому что их на порядок легче расшарить для совместной работы с нетехнарями.
avatar
Соглашусь, но с той оговоркой, что те же гуглодоки у меня давно проходят по статье «выходных форматов», а пишу тексты я или в Tiddlewiki, или в Akelpad/Writemonkey.
avatar
При совместной работе, увы, нельзя позволить себе отдельный от всех внутренний рабочий процесс.
avatar
Если так, то да. У меня просто совсем редки случаи синхронного редактирования чего-бы то ни было.
avatar
Это откровенно слабый аргумент, но мне очень не нравится word-like workflow.

Гуглдоки у меня чаще всего это инструмент публикации и/или обсуждения. Хотя вон в roll20 форумы ввели, там тоже неплохо.

И да, так уж сложилось что в потенциальных соавторах у меня только технари.
avatar
Ну да, кому арбуз, а кому свиной хрящик.
avatar
остаётся только добавить, что на том же гитхабе есть собственно и вики, прилагающиеся при желании к каждому проекту. главное их достоинство — возможность разрешить правки всем, а не только участникам проекта; а технически эти вики всё равно являются репозиториями, которые можно клонировать, ветвить как хочешь, коммитить много изменённых страниц сразу и так далее.
Только зарегистрированные и авторизованные пользователи могут оставлять комментарии.