Пишите по-русски!

Писать по-русски — значит писать красиво, правильно и понятно. Писать по-русски — легко и приятно1.

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

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

Каждый абзац — для отдельной идеи. Чем короче абзац, тем яснее мысль.

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

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

Помните, что иногда одна картинка может заменить сотню слов.

Всегда помните о том, для кого Вы пишете. Ваш Читатель — это не Вы. Любите своего читателя и будьте к нему снисходительны.

Гиперссылки

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

Не превращайте в гиперссылки второстепенные и малосущественные детали. Мусор не стоит того, чтобы на него обращали внимание.

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

Не стоит превращать в гиперссылку длинную фразу, с другой стороны, ссылка в виде единственного слова — тоже не очевидна.

Особенности PmWiki в отношении русского языка

Одна из ключевых возможностей технологии WikiWiki — это, так называемые, ВикиСлова (WikiWord).

довести до ума В русском же — всё плохо: ВикиСлово, ВикиСловами, ВикиСловах, ВикиСлова — вот несколько форм одного понятия. Ни один Wiki-движок не понимает [пока] что перед ним одно и то же понятие и ссылки должны показывать на одну и ту же страницу.

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

Данная локализация PmWiki является неофициальной и «самодельной». ВикиСлово, да и просто обычную ссылку от русского слова, Вам сделать не удастся.

Но:

  • PmWiki позволяет устанавливать атрибут Название Страницы с помощью команды
  • PmWiki с помощью конструкции Page? может подставлять в качестве источника ссылки Название Страницы page

Таким образом, Вы даёте своим страницам внятные английские имена (эта страница, например, имеет имя Rules — посмотрите в адресную строку браузера) и в первой же строчке каждой страницы с помощью команды устанавливаете действительные Названия Страниц (эта страница называется «Правила разметки: Стильный гипертекст»). Теперь, для того чтобы сослаться на эту страницу, достаточно использовать конструкцию Rules. Вот и всё.

К сожалению, в полной мере испытать удовольствие от работы с WikiWiki русскоязычным пользователям не удастся: существующие движки пока не способны адекватно работать с русскими ВикиСловами. Я настойчиво предлагаю Вам пользоваться следующими рекомендациями.

Примечания

1 если, конечно же, Вы знаете русский (↑)