Есть ли какое-то приложение, которое я могу использовать, чтобы написать документацию для автономного использования, а затем скопировать / вставить текст позже в Википедию? Если нет, то есть ли какой-нибудь конвертер вики в pdf или doc в wiki?
1 ответ
2
Что - то вроде этого? Понятно работает в автономном режиме. Цитирование ...
Использование вики-разметки без вики
Даже при наличии Wiki в качестве основного хранилища документации, не вся документация заканчивается в Wiki. Некоторая документация должна управляться как часть дерева исходных текстов - например, Readme, инструкции по компиляции и тому подобное. Эта информация обычно либо в виде простого текста, либо в виде текстового процессора, в основном совместимого с Microsoft Word. У обоих есть выбор проблем. Документы Word большие, раздутые, сложнее для контроля версий и не читаются в среде оболочки (попробуйте кошку или хвост документа Word :-D). Обычный текстовый формат не имеет визуальной структуры и без заголовков, полужирный / курсив, размеры шрифтов и т.д. Труднее читать.
Некоторые проекты, над которыми я работал, пытались использовать HTML в качестве формата документации - но редактировать их было сложно с помощью «редакторов-программистов»… и HTML, сгенерированный MS-Word, не намного лучше двоичного формата с точки зрения читабельности и управления версиями.
Один формат, который работает удивительно хорошо, - это простой текст со структурой разметки Wiki. Существует широкий выбор различных разметок, одна из которых мне нравится больше всего, это разметка Textile (которая реализована во многих вики-системах, включая Confluence). Текстиль очень легко запомнить, его естественно читать, и он придает документу достаточную структуру, не мешая ему. Использование Textile в качестве «исходной разметки» позволяет нам копировать и вставлять содержимое документа непосредственно в Wiki, если это потребуется. Текстиль также может быть очень легко преобразован в полноценный HTML с использованием библиотек, доступных для всех языков, представляющих интерес (в моем случае - C #, Java, Python, Ruby - и, мы надеемся, также найдем что-то для Objective-C) для преобразования его в HTML.
Лучшая особенность использования Textile - это то, что некоторые редакторы, а именно TextMate на Mac, изначально поддерживают Textile и правильно отображают заголовки и атрибуты шрифта даже без предварительной обработки. А с функцией предварительного просмотра даже сразу генерировать HTML. Подобное можно сделать с помощью плагина в JEdit, а также в Notepad++ с этим файлом синтаксиса.