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

Я, кстати, люблю писать документацию. Что для программиста, как я подмечал, редкость. Причем, мне серьезно кажется, что у меня это получается довольно неплохо (пока никто вслух не жаловался :-) ). Удается, знаете ли, описать все системно, чтобы текст не выглядел как набор разрозненных примечательных фактов из истории проекта, а чтобы описание развивалось от общего к частному, и чтобы читающий всегда знал, куда посмотреть, чтобы найти, что ищет.

Но меня всегда преследовала одна очень гадкая проблема: я никак не мог дописать все, что запланировал.

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

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

Раньше свою документацию я писал, в чем придется, от Word'а до HTML'а в текстовом редакторе. Но какое-то время назад мой коллега практически принудил меня попользоваться wiki (Серега, спасибо!), хотя я долго сопротивлялся, говоря, что вся идея просто кошмарна. Я был неправ. Wiki резко повысила мою продуктивность, потому что вдруг оказалось, что о куче мелочей, сопровождающих документирование, уже позаботились умные люди, и все, что тебе остается — просто писать текст.

Ну или не совсем просто. На качество работы любого специалиста, безусловно, оказывают влияние инструменты, которыми он пользуется. Однажды я минут 20 слушал пересказ истории об одном автомеханике, который примерно такое же время объяснял, почему именно его любимая отвертка, которую он сделал сам на станке, лучше, чем любая другая отвертка, которую он видел в своей жизни. Может, она и не была настолько замечательной, но я думаю, что одно то, что она ему так нравилась, было большим подспорьем в работе.

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

Сравнение

Сразу оговорюсь, что я, конечно, никакой не "эксперт", не проводил вдумчивых анализов, и скорее всего, некоторые проблемы решаются какими-нибудь настройками. И все это в любом случае субъективно.

Внешний вид

Это самое первых приятное впечатление от Doku — она гораздо симпатичней Wacko. Особенно мне не нравились в Wacko несуществующие ссылки, вот сравните:

В Wacko после несуществующей ссылки рисуется подчеркнутый знак вопроса, а сама ссылка почеркивается рыжим пунктиром. В Doku несуществующая ссылка просто красная, а существующая -- зеленая

А еще у Doku иконка симпатичная :-).

Автоматические ссылки

Одна из концепции многих wiki-систем — делать автоматические ссылки из слов НабранныхВCamelCase. Предполагается, что человек пишет текст, и когда в нем встречается термин, на который надо сделать ссылку, он просто пишет его без пробелов. Это придумал англоговорящий человек для своего языка. А в русском языке, как известно, существительные склоняются, и это очевидно напрочь убивает всю фичу. Поэтому в документации на русском языке все ссылки делают вручную.

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

Wacko настаивает на создании таких ссылок. Поэтому мой текст вечно был в знаках вопроса в тех местах, где никогда ссылок не будет. Чтобы их убрать, приходилось перед каждым идентификатором в тексте ставить значок "~", что неудобно.

Doku автоматических ссылок не создает (хотя в конфиге можно включить).

URLизация ссылок

Одна из нерешенных проблем русского интернета: как загнать русские слова в URL, чтобы не было криво. Можно загнать как есть, но тогда они кодируются в некрсивые %XX. Можно переводить их в транслит, но это тоже не шибко лучше.

Doku делает проценты, а Wacko — транслит, и здесь я предпочтение никому отдать не могу, все плохо :-). Просто не смотрю на URL.

Зато что я точно понял, что названия страниц надо делать желательно из одного слова в единственном числе и именительном падеже. Так гораздо проще ставить потом ссылки в тексте, когда не приходится вспоминать, как же именно названа страница.

Синтаксис в общем

Синтаксис Wacko богаче. И это мне тоже не нравится, потому что есть много способов сделать одну и ту же вещь. Например, там есть специальный тег (??...??), которым можно задать вопрос и привлечь внимание. А есть специальный тег, которым просто привлекается внимание (!!...!!). Разные люди пользуются то одним, то другим.

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

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

Заголовки

В рассматриваемых вики (да и в большинстве других) заголовки оформляются отвратительно.

Wacko:

== Первый уровень ==
=== Второй уровень ===
==== Третий уровень ====

Doku (еще хуже):

====== Первый уровень ======
===== Второй уровень =====
==== Третий уровень ====

Во-первых плохо то, что надо повторять одинаковое число знаков до и после, это не для людей занятие. Нет, может и не надо, но я никогда не находил времени, чтобы проверить, и уж точно никогда не запомню, где оно надо, а где нет. Наверное отчасти из-за этого в обеих вики для оформления заголовков есть кнопочки над полем редактирования. И тут Doku сильно выигрывает: для них есть просто запоминаемые клавиши: Alt+1, Alt+2... Это важно, потому что необходимость обращаться к мышке при наборе больших объемов текста напрягает.

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

Кстати, обоих этих недостатков лишен синтаксис Markdown, которым я пишу этот блог:

# Первый уровень
## Второй уровень
### Третий уровень

Вообще, если бы была хорошая вики с markdown-синтаксисом, это было бы замечательно. Заголовки — это не единственное, где он лучше.

Оглавление

Doku делает оглавление автоматически и запихивает его в правый верхний угол текста, чтобы не мешало читать.

В Wacko надо каждый раз вписывать тег, который обычно идет в начале, а значит отодвигает сам текст ниже.

Примечания

В Doku примечания превращаются в сноски, которые относятся в низ страницы, как в книжках. Это было бы неудобно читать, но при наведении мышки на сноску ее текст всплывает рядом в подсказке (не браузерной, а javascript'овой, поэтому туда можно написать много, и там работает форматирование). Поэтому их менее неудобно читать. Хотя и симпатично :-).

Примечания в Wacko оформляются обычно просто мелким текстом. Без извратов.

Таблицы

Тут на 117,3 очка вперед выигрывет Doku. Вот ее синтаксис:

^Заголовок  ^Заголовок  ^
|Текст      |Текст      |
|Текст      |Текст      |

Еще Doku умеет задавать выравнивание исключительно интуитивно понятным способом — достаточно двух пробелов с противоположной стороны:

|Налево  |  По центру  |  Направо|

И еще colspan'ы может задавать...

|Текст   |Текст на две колонки  ||
|Текст   |Текст        |Текст    |

А вот Wacko:

#|
||Текст|Текст||
||Текст|Текст||
|#

То есть Wacko настаивает на том, чтобы начало и конец таблицы, а также начало и конец строк, оформлялись вручную. Doku делает это самостоятельно. Да и ничего дополнительного — заголовков, выравнивания, colspan'ов — в Wacko, похоже, нет.

Код

Кусок кода в Doku оформляется просто отступанием всего куска на два пробела слева. Просто и читаемо. Если текст сдвигать не хочется, то его можно вместо этого заключить в теги <code>..</code>. С тегами можно задать и посветку синтаксиса: <code html>.

В Wacko блоки оформляются чуть менее элегантно на мой вкус: %%(html) .. %%.

Но вот что мне в ней действительно не понравилось, это то, что моноширинной текст, который я обычно использую для идентификаторов внутри текста, она еще зачем-то подкрашивает противным желтым фоном.

Решающие моменты

Но среди всего прочего окончательно меня склонили в сторону Doku еще два момента.

В Wacko меня преследует одна штука, которая, правда, вполне может быть связана исключительно с браузером. Во время редактирования страницы, чем больше я что-то стираю и пишу, тем больше весь процесс начинает тормозить. Доходит до того, что написанное предложение начинает медленно появляться в окне по паре букв в секунду... Раздражает слегка :-)

Самый для меня сильный плюс Doku — это редактирование по разделам. Она автоматически бьет текст от заголовка до заголовка на разделы, в кторых висит кнопочка "edit", по которой этот раздел можно отредактировать отдельно от всей страницы. Этим решается неудобство, когда при переходе в режим редактирования особенно длинной странице очень трудно найти место, которое хотелось поправить в дли-и-инной textarea. Во многом тут уже точно виноват мой Firefox, который не в состоянии делать поиск внутри textarea (древний баг), но мне приятно, что с Doku я от этого не страдаю.

HTH!.

Комментарии: 47 (особо ценных: 1) (feed)

  1. Александр Вольф

    Меня лично во всех wiki-движках бесят "ссылки из слов НабранныхВCamelCase", уже который раз порываюсь в каком-нибудь движке переделать их под себя, но так все и не собрался...

  2. chubajs

    уже больше года пользуюсь DokuWiki, описываю с помощью него задания программистам. Считаю очень удобным, самым удобным :) Кстати никогда не пользовался CamelCase - всегда создаю страницы с помощью квадратных скобок

  3. bogus

    А на что переделать? Очевидное (оно же и единственное) удобство ТакихСсылок - это то, что они набираются так же, как и простой текст. И не надо думать, какой будет адрес, что написать в качестве текста ссылки и т.д.

    Кстати, в mediawiki ссылки так не оформляются, насколько я знаю.

  4. chubajs

    кстати! Вот вам и Markdown для DokuWiki:
    http://wiki.ioslo.net/dokuwiki/markdown

  5. Lalex

    Иван, спасибо за наводку. :) собственно вопрос у меня такой: предположим я на хорстинге (сервере в локале) поставлю какой-нибудь вариант, будет ли у меня возможность к примеру разделить два-три проекта которые между собой никак физически не соотносятся, но имеют к примеру общие термины и определения, т.е. возьмем слово фолксономия - в обоих проектах есть, но сами проекты абсолютно разные (один к примеру - сеть салонов мебели, а второй - персональный)?
    (надеюсь поймете что я имею ввиду ;) )

  6. Mendokusee

    Особо ценный комментарий

        <p>Факты, чтобы не создавать ошибочных впечатлений у читающих документ.</p>
    

    <ol> <li> <p>Конечно, в WackoWiki есть более одной темы оформления (если точно, то 3+11 — http://wackowiki.com/WackoThemes)). Приводя скриншот, стоит сказать, что именно эта понравилась вам больше всего.</p> </li> <li> <blockquote> <p>Во-первых плохо то, что надо повторять одинаковое число знаков до и после, это не для людей занятие.</p> </blockquote> <p>В Wackowiki не нужно. Справа достаточно двух.</p> </li> <li> <blockquote> <p>Наверное отчасти из-за этого в обеих вики для оформления заголовков есть кнопочки над полем редактирования. И тут Doku сильно выигрывает: для них есть просто запоминаемые клавиши: Alt+1, Alt+2…</p> </blockquote> <p>В Wackowiki есть просто запоминаемые клавиши Ctrl+1, etc. Точнее вам скажет подсказка, которая встроена в редактор. С Alt-комбинациями есть определённые проблемы в некоторых браузерах, афаик.</p> </li> <li> <blockquote> <p>Да и ничего дополнительного — заголовков, выравнивания, colspan’ов — в Wacko, похоже, нет.</p> </blockquote> <p>Colspan-ы есть. В Dokuwiki можно написать внутри таблицы список?</p> </li> <li> <blockquote> <p>Но вот что мне в ней действительно не понравилось, это то, что моноширинной текст, который я обычно использую для идентификаторов внутри текста, она еще зачем-то подкрашивает противным желтым фоном.</p> </blockquote> <p>3+11 тем, напоминаю.</p> </li> </ol>

  7. Mendokusee

    Вот эта великолепная разметка — markdown?

  8. PCPA

    Касательно внешнего вида согласен. Но в Wacko его не сложно довести до желаемого;)

  9. Иван Сагалаев

    Mendokusee, спасибо за исправления, очень полезно.

    Форматирование комментария я поправил. Да, это Markdown, и форматируется это примерно так:

    1. > Цитата
    
      Ответ
    
    2. > Цитата
    
      Ответ
    

    Любой такой синтаксис требует привычки, конечно.

  10. Иван Сагалаев

    Lalex, да можно. У многих вики есть возможность сделать неплоскую структур страниц. В Doku это называется namespaces, похоже на директории (а на сервере это и есть директории).

    Если имя страницы содержит префикс с двоеточием [[project1:page]], то она относится к namespace "project1", причем удобчно, что ссылки из нее по умолчанию ссылаются тоже внутри этого namespace'а. Чтобы сослаться на другой namespace, надо указать его явно в ссылке: [[glossary:term]].

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

  11. kukutz
        <p>Продолжу наведение справедливости.</p>
    

    <ol> <li> <blockquote> <p>Wacko настаивает на создании таких ссылок.</p> </blockquote> <p>Опция конфигурационного файла disable_wikilinks отключает это поведение. Более того, если не нравится вопрос - это легко настраивается в файле lang/wakka.all.php</p> </li> <li> <blockquote> <p>Примечания в Wacko оформляются обычно просто мелким текстом. Без извратов.</p> </blockquote> <p>В Wacko есть примечания-сноски.</p> </li> </ol> <p>Ну и Вы не ответили, в Dokuwiki можно написать внутри таблицы список?</p>

  12. Иван Сагалаев

    Я не только про список не ответил :-). Мне очень не хочется переводить разговор в защиту-нападение, поэтому я еще раз скажу, что статья очень субъективна и отвечает на вопрос, почему мне понравилась DokuWiki, и что "не Wacko'й единой". Я знаю, что Wacko — хорошая штука, она ведь едва ли не самая популярная среди русскоговорящих технарей. Но просто душа не легла.

    Вот после такого вступления теперь могу про списки и все остальное:

    Конечно, в WackoWiki есть более одной темы оформления

    Да. И во многих системах есть темы (в Doku, кстати, тоже). Но я ценю системы, которые по умолчанию сразу работают хорошо, чем меньше приходится заниматься подгонкой, тем лучше. Я, кстати, видел две остальные темки, которые с Wacko идут, но они тоже не понравились.

    Во-первых плохо то, что надо повторять одинаковое число знаков до и после, это не для людей занятие.

    В Wackowiki не нужно. Справа достаточно двух.

    Это еще хуже :-). Я понимаю, откуда "два", но это не делает синтаксис более интуитивно понятным или читаемым.

    В Wackowiki есть просто запоминаемые клавиши Ctrl+1, etc. Точнее вам скажет подсказка, которая встроена в редактор.

    В Doku я навел мышку на кнопку, и мне там написали shortcut. Если бы не написали, я бы и про Doku думал, что в ней "этого нет". Как подумал и про Wako. Сейчас полез по совету Mendokusee посмотреть в help. Не нашел. Но оказывается там две кнопки с help'ом :-). Во второй — есть.

    С Alt-комбинациями есть определённые проблемы в некоторых браузерах, афаик.

    Это да. Как раз у меня в линуксовом Firefox они переключают табы. Меня спасает то, что я ими практически не пользуюсь.

    В Dokuwiki можно написать внутри таблицы список?

    Нельзя. Как я, опять же, писал, у Doku синтаксис в принципе беднее, и мне это нравится больше вот почему:

    • Более богатый синтаксис сложнее. В данном конкретном случае, когда подавляющее большинство моих таблиц не содержат списков, абзацев, заголовоко и цитат, я предпочитаю, чтобы синтаксис был проще.
    • Слишком большой выбор возможностей — это не всегда хорошо, потому что сам процесс принятия решения при выборе тоже чего-то стоит, он отвлекает.
    • "Список в таблице" вообще довольно изощренная конструкция. Если мне в моей документации захочется написать такое, это будет серьезным способом задуматься, а не пишу ли я что-то слишком сложно, что потом будет сложно понимать? Пожалуй, это даже больше, чем пресловутое "понравилось", продвинуло меня в работе: Doku подталкивает к более простыме решениям.

    На самом деле, все wiki-синтаксисы беднее HTML, и они и не создавались для того, чтобы его заменять. Поэтому вопрос надо ставить не что оно может, а хватает ли мне того, что оно может. Я доволен Doku'вским синтаксисом, а кому-то его не хватает, поэтому они пользуются Wacko.

    Еще раз спасибо за комментарий!

  13. Peter A. Shevtsov

    Почему-то я не заметил упоминания Mediawiki...
    Неужели никто не использует?
    Мы в отделе используем и очень довольны.

  14. mourner

    Я вики практически не пользовался, но...

    Собственно насчет языка разметки - наиболее красивым, удобным, перспективным и активно развивающимся на данный момент, как по мне, является Textile. Правда, сейчас он на прекрасном уровне (вместе с Markdown) поддерживается только в Instiki (на Ruby).

    Вот не знаю, как там в MoinMoin - Вань, ты как любитель Python должен был бы его попробовать. :) А что, классная идея для следующей статьи - MoinMoin vs Instiki (+ vs вики из предыдущего обзора).

  15. Иван Сагалаев

    Мне интересно было бы пробовать написанную на Питоне вики, если бы я собирался ее хачить :-). Но я не собираюсь: невозможно написать весь софт, даже если очень хочется :-)

    MoinMoin я видел, и чем-то она мне не понравилась, а чем — уже не помню.

  16. BOLK

    Заголовки в WackoWiki можно делать вот так:

    ===заголовок==
    ====заголовок==

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

  17. BOLK

    Да, сначала написал коментарий, чтобы незабыть и только потом увидел, что тут уже побывали разработчики :) Так что на коментарий можно не отвечать :)

  18. Mendokusee

    Ну что же, ещё один (очередной) голос за отмену завершающих равно в заголовках. Я, наверное, в следующем заплыве таки оторву их, как оторвал в http://pixel-apes.com/waka31

    Про то, что Shortcuts надо подписать — правильно. В одной ветке я это уже сделал, скоро волью в ваку.

    Любой такой синтаксис требует привычки, конечно.

    В ваковики, кажется, гораздо сложнее случайно испортить текст.

  19. Джонсанятина

    <i>Но я ценю системы, которые по умолчанию сразу работают хорошо, чем меньше приходится заниматься подгонкой, тем лучше.</i>
    DokuWiki без укруток и включения авторизации и ACL может работать только на десктопе (а ведь могли бы создать разные сборки). Зато если нужно поставить на внешнем хосте, то мне, например, пришлось погружаться в шаманство. Уже одно то, что почта работает на основе дефолтовых php настроек (из php.ini) очень сильно раздражает. C WackoWiki у меня таких проблем не возникало.

  20. Julik

    Согласно недавнему опросу в мейл-листе Markdown-discuss его поддерживают (цитата):

    Instiki (built-in)
    DokuWiki (external plugin)
    Oddmuse (external module)

    • плагин для MoinMoin
  21. Александр Вольф

    Посмотрел DokuWiki - довольно интересная реализация. Править и создавать страницы можно двумя способами - что есть плюс. Но для полного представления хотелось бы посмотреть и другие движки :) Так как их достаточно много, то начать осмотр хотелось бы с тех, которыми реально пользуются. Кто и что пользует помимо Wacko и Doku и почему?

  22. sam

    У нас на фирме используетса basecamp(для планов, отчётов, обсуждений и тд...) and campfire(для live chata c обменом файлов и удобной history)

    http://www.37signals.com/

  23. Max Ischenko

    JFYI: wp-docuwiki.

  24. kopeika

    У меня был такой путь, начинал с mediawiki(года так полтора назад), потом WikkaWiki(что наверное клон ваки), потом dokuwiki, на ней и остановился, причем используется в двух проектах, один на фирме, за последнии годы накопилось много support'ных майлов, клиенты задают в принципе часто одни и теже вопросы, написан был формуляр на VBA, которые автоматом парсит майлы в outlook и выкидывает их в UTF-8 в докувики + есть хорoший template с календариком от http://www.chimeric.de/wiki/dokuwiki/templates/arctic

    в другом месте используется как навигатор помощи для одного трекера, причем ACL завязано через базу MySQL пользователей трекера

  25. /lekcyc lllumukcyc

    Вопрос: а как Вы относитесь к тому, что Docu не использует базу данных?

    Я вижу в этом и положительные и отрицательные стороны, и чувствую себя странно. Поскольку мы столько лет шли к базам данных от хранения данных в файлах (права доступа, одновременная запись...) и тут — бац!!! лучшая вики сделана на файлах...

  26. Иван Сагалаев

    Замечательно отношусь :-). Wiki — это как раз тот тип софта, о котором я писал, в котором от БД вполне можно отказаться.

  27. agat

    У меня никак не получается сделать так, чтобы редактировать документы не мог любой желающий. А только по логину/паролю.

    Юзеров я вроде сделал в системе(можно зайти по логину/паролю), но редактировать содержимое по прежнему может любой желающий.

    Как быть?

  28. Иван Сагалаев

    Как обычно, в общем-то... Поискать в Google, найти какой-нибудь форум поддержки...

  29. [...] Две вики. Сравнение двух wiki-движков: Wacko Wiki и DokuWiki. Автор, Иван Сагалаев, достаточно разумно, на мой взгляд, аргументирует, почему он предпочитает вторую систему, но создатели первой, своими комментариями к статье, не остались в долгу и указали на массу неточностей. Одним словом, победила дружба. В нескольких проектах, где я участвовал на ведущих ролях, и которые по разным причинам оставлял, под конец у меня всегда возникало возвышенное желание написать к ним большую подробную документацию. Чтобы другому человеку, который подхватит проект после меня, не приходилось уничтожать себе мозг слишком большим количеством предположений, отчего это сделано так, а не эдак, и вопросов, где начинать искать хвост какого-нибудь бага. [...]

  30. Artemiy

    Задавался вопрос — чем еще пользуется народонаселение.
    Есть очень хороший и мощный продукт Atlassian Confluence (http://www.atlassian.com/software/confluence/).
    У него более приятный синтаксис. Вместо страшных === можно просто писать h1.Заголовок или h2.Менее важный заголовок.
    В нем же есть блоговая функциональность — можно внутри спейса привязывать статьи к датам.
    Сама по себе система симпатичная, красиво оформлена.
    Есть еще какие-то более важные вкусности, вспоминать о которых сейчас лениво.

    Минусов ДВА. Минус номер рас: это платный продукт. Бесплатным он является только для некоммерческих пользователей. Минус номер два: написано это хозяйство, если память мне не изменяет, на java + jsp. Соответственно нужен сервер приложений, например tomcat или resin. Для кого-то это по религиозным предпочтениям может быть неприемлемо.

    Вобщем, на работе означенная конфлюенция, а для дома — у меня Dokuwiki.

  31. Глеб

    В Доку можно замаскировать имена файлов, то есть в урлах будет по-английски, а в структуре документа русские заглавия. Для этого адо немного поконфигурить саму Доку (всатвить опцию - "Использовать первый заголовок в качестве имени страницы" и вместо обычных "хлебных крошек" включить навигацю "You are here" - последняя функция более новая, поэтому поддерживает использование заголовков) После этого именем страницы везде будет первый заголовок любого уровня.

    Ну и ссылка типа [[docs]], ведущая на страницу "Документация" будет автоматом переписываться на "Документация". Могу подробнее, если интересно. САм как раз адаптирую доку для одного усскоязычного проекта.

  32. Глеб

    Добавлю, что Доку выглядит сильно законченней, чем Вака. У меня на хостере Вака вообще умерла по неясной причине - видимо, проблемы с кэшированием. До того была проблема с картинками - вака не умеет их нормально отдавать пользователю.

    Кстати, ввыерху была тема про списки в таблицах, так вот:

    Ребят, Доку поддержэивает флоаты любых блоков! Таблицы не нужны!

  33. Александр Вольф

    2Глеб: Я хочу подробностей :)

  34. Stas
        <p>В Firefoxe можно легко решить проблему с нечитаемостью “русских” URLов:<br />
    

    плагин HumanURL, и с редактированием textarea в редакторе <a>TextArea Sputnik</a>.</p>

  35. [...] Две вики [...]

  36. TeXHaPb

    А как в DocuWiki использовать плагины? Как их вызывать? Можно-ли где-нить скачать исходники всех их страниц справки, а то интернет есть под рукой не всегда? А то система приятная вроде, но много непонятностей.

  37. Andmo

    Брошу таки реплику.
    Вака лучше документирована чем дока. И функциональней. Нет проблем дописать что то свое, или обрезать все "лишнее".
    1. По моим наблюдениям (сайтам), на тысячи читателей приходится полписателя. И пишут главным образом в комментах. Иными словами, друзья, владелец вики является единственным писателем, если посещаемость не превышает сотни-другой хостов в день.
    2. Читать лучше Ваку - больше возможностей для верстки, дизайна, и прочих фишечек.
    3. Но найти что то на сайте очень проблематично и там и здесь, если кол-во страниц сайта хотя бы тысяча :(
    4. о базе данных. Тормоза у Ваки конкретные. :( Поставте в конфиге дебаг= 2 и ужаснитесь колву запросов, которыми вака задает. И все типа : Да кто ты такой чтоб тебе показывать эту гиперлиньку на этой страничке, где хозяин такой-то и разрешал ли он на это смотреть, редактировать и комментировать.
    Увы. нет идеального инструмента.

  38. Ivan A-R

    <b>Andmo</b>, Не сказал бы, что ваку читать легче. Как верно отметил автор статьи, богатый синтаксис вовсе не преимущество. Я сам частенько забываю, где какое правило форматирования применил. Какая тут вёрстка и дизайн? Куча мала получается.

    Согласен с тем, что что-то своё в ваку дописать достаточно просто. Только это должно быть тоже что-то достаточно простое. Любая мало-мальская сложная доработка ставит в тупик из-за плохой документированности и продуманности API ваки.

    Вообще, когда смотришь вакин код, волосы начинают шевелиться. Яркий пример, как писать не надо. Я понимаю, что вака писалась разными людьми в разное время, но от этого мне легче не становится.

    И положу плюс в копилку доку, за то что использует plain текст. Всё же для управления файловой системой средств выше крыши. А для БД приходится изобретать велосипеды.

  39. Mendokusee

    И все типа : Да кто ты такой чтоб тебе показывать эту гиперлиньку на этой страничке, где хозяин такой-то и разрешал ли он на это смотреть, редактировать и комментировать.

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

  40. flydoc

    ...а мы используем JSPWiki, и в основном довольны тем что это Java. Она использует текстовые файлы, хотя БД проблем тоже не составила бы. Хороший синтаксис таблиц. Ну и нашли приятную тему. Система развивается, хотя и не так активно, как хотелось бы.

    До того использовали phpWiki, но было много проблем с кодировками (база в MySQL + настройки PHP + ... - в итоге надоело).

    На первый взгляд возможности всех перечисленных систем схожи.

    При выборе рекомендую обратить особое внимание на возможность редактировать секцию, а не страницу целиком. В JSPWiki это появилось недавно, в mediawiki широко используется.

  41. [...] p.s. Хотел добавить. Вообще вики системы я очень люблю. Совсем недавно читал интересный пост о двух ярких представителях у Ивана Сагалаева. Сам пользуюсь DokuWiki для описания различных тасков и проектов (по работе) уже более года. Выбрал я ее помнится изза некой простоты - простоты установки, простоты начала работа. Привык настолько что о замене даже и не думаю. Сейчас вот немного тэгирования нехватает и дизайн скучноват - но это проблемы решаемые. Если что - советую :) Тэги: ajaxknowledgebasereviewtextwiki  [...]

  42. Глеб

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

    И еще камешек: в Ваке всегда лезут служебные символы, вроде: !/НазваниеСтатьиКудаСсылка. Да, набив с десяток буковок, это можно забить...

    А на Доку можно сделать такой сайт:

    http://www.mierzejewski.net/

    Есть еще вопросы?

  43. Zander

    В текущей версии DokuWiki есть возможность при необходимости вставлять в текст wiki код на HTML и PHP, что "под свою ответственность" позволяет сделать всё, что душе угодно. Например, динамически формируемый фрагмент страницы. Это во-первых.

    А во-вторых, я перепробовал с десяток разных движков (в т.ч. и MediaWiki, и WackoWiki, и PMWiki) и пришел к выводу, что даже при наличии изначально более мощных и функциональных движков, DokuWiki - это "автомат Калашникова" среди wiki - просто, быстро, надёжно. Очень понравились interwiki-ссылки и пространства имён.

    Из мелких неприятностей: замечено неадекватное поведение DokuWiki при попытке создать страницу с длинным кириллическим именем.

  44. Гость
  45. Михаил

    Парни.
    А как в ваших вики производится четкий поиск по конкретизированным полям.

    Например:
    1. НАЙТИ ВСЕ НАСЕЛЕННЫЕ ПУНКТЫ, В КОТОРЫХ КОЛИЧЕСТВО НАСЕЛЕНИЯ = 10 000 чел
    2. Найти людей родившихся в 1970 году
    2. Найти людей родившихся в городе Москва, или в московской обл.

    Другими словами как реализуется хранение и обработка данных каких либо объектов (типо АТО, Человек, Организация).

  46. Муркт

    А как в ваших вики производится четкий поиск по конкретизированным полям.

    Не видел ни в одной вики таких конкретизированных полей. Можно пример?

  47. [...] Просто документация должна быть в этом случае менее формализованной и более доступной для изменения всеми участниками. Да, подразумевается грамотное использование wiki-систем. [...]

Добавить комментарий

Format with markdown