Difference between revisions of "JaWiki:Advices"

From JaWiki (Jabber/XMPP wiki)
Jump to: navigation, search
m (Про FixMe)
(сформулировал советы по написанию статей)
Line 1: Line 1:
−
=Советы для пользователей JaWiKi=
+
== Советы для пользователей JaWiKi ==
−
* Для избежания неприятных ситуаций желательно отключить кеширование страниц, ибо можно получить информацию, которая уже не актуальна и была давно измененена. Отключить кеширование можно зайдя в "другие настройки" на странице [[Special:Preferences|настроек]]
+
 
 +
=== Пользование JaWiki ===
 +
 
 +
* Для избежания неприятных ситуаций желательно отключить кеширование страниц, ибо можно получить информацию, которая уже не актуальна и была давно измененена. Отключить кеширование можно зайдя в «другие настройки» на странице [[Special:Preferences|настроек]]
 +
 
 +
=== Написание статей ===
  
 
* Те места текста, которые вызывают у вас при написании или при прочтении, сомнения стоит помечать ссылкой [[FixMe]].
 
* Те места текста, которые вызывают у вас при написании или при прочтении, сомнения стоит помечать ссылкой [[FixMe]].
 +
 +
* Статьи, не начинающиеся с <tt>Eng:</tt>, должны быть написаны на <u>правильном</u> русском языке.
 +
** Старайтесь избегать перегрузки статьи техническими терминами. Если значение термина неочевидно среднему пользователю Интернета, указывайте в скобках или сноской внизу страницы его толкование. Если же его нельзя истолковать парой фраз, надо писать отдельную страницу. Если её ещё нет, просто сделайте ссылку, кто-нибудь обязательно напишет.
 +
** Категорически не рекомендуется употребление жаргонизмов ([[ICQ|аська]], [[JID|жид]] и т.п.).
 +
** В русском языке 33 буквы! С недавних пор написание &laquo;'''Е'''&raquo; вместо &laquo;'''Ё'''&raquo; считается ошибкой. Будьте так добры, уважайте свой (ну или хотя бы мой) язык, расставляёте точки над &laquo;'''Ё'''&raquo;!
 +
** Советую полистать школьные учебники и освежить в памяти правила пунктуации, в том числе правила постановки знака &laquo;&mdash;&raquo; (тире). Чтобы избежать проблем, создаваемых обилием кириллических кодировок и не всегда совместимых браузеров, ставьте тире как <tt>&amp;mdash;</tt>
 +
** Не используйте в русскоязычных текстах английских кавычек ("). [[Unicode|Юникод]] умеет наши, русские кавычки. Соответствующие HTML-коды: <tt>&amp;laquo;</tt> для '''&laquo;''' и <tt>&amp;raquo;</tt> для '''&raquo;'''
 +
 +
* Следите за структурой статьи. Оглавление создаётся автоматически на основе использованных в тексте заголовков.
 +
** Если требуется озаглавить страницу по-русски, то согласно [[JaWiKi:TechRules#.D0.98.D0.BC.D0.B5.D0.BD.D0.B0_wiki_.D0.B4.D0.BE.D0.BB.D0.B6.D0.BD.D1.8B_.D0.B1.D1.8B.D1.82.D1.8C_.D0.B0.D0.BD.D0.B3.D0.BB.D0.BE.D1.8F.D0.B7.D1.8B.D1.87.D0.BD.D1.8B.D0.BC.D0.B8|правилам]], непосредственно имя следует написать по-английски, но русскоязычное название рекомендуется указать в начале самой страниче в виде<br><tt><nowiki><big>'''Название страницы'''</big></nowiki></tt>
 +
 +
* Минимизируйте использование HTML-тэгов <tt>&lt;table&gt;</tt>, <tt>&lt;i&gt;</tt>, <tt>&lt;b&gt;</tt>, <tt>&lt;img&gt;</tt>, <tt>&lt;h[1-6]&gt;</tt>, <tt>&lt;a&gt;</tt> в тексте страницы.
 +
** Таблицы оформляются так:<br><tt><nowiki>&nbsp;{|</nowiki><br>&nbsp; | строка 1, ячейка 1<br>&nbsp; | строка 1, ячейка 2<br>&nbsp; |-<br>&nbsp; | строка 2, ячейка 1<br>&nbsp; | строка 2, ячейка 2<br>&nbsp; |-<br>&nbsp; | строка 3, ячейка 1<br>&nbsp; | строка 3, ячейка 2<br>&nbsp; |}</tt>
 +
** Рисунки подписывайте<br><tt><nowiki>[[Image:адрес_рисунка|thumb|Подпись к рисунку. Внутри подписи можно использовать [[ссылки]] и ''другие'' элементы форматирования]]</nowiki></tt>
 +
** Начинать иерархию заголовков лучше сразу со второго уровня (<tt>== Заголовок ==</tt>).
 +
  
 
[[Category:JaWiki]]
 
[[Category:JaWiki]]
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Revision as of 20:02, 27 May 2007

Советы для пользователей JaWiKi

Пользование JaWiki

  • Для избежания неприятных ситуаций желательно отключить кеширование страниц, ибо можно получить информацию, которая уже не актуальна и была давно измененена. Отключить кеширование можно зайдя в «другие настройки» на странице настроек

Написание статей

  • Те места текста, которые вызывают у вас при написании или при прочтении, сомнения стоит помечать ссылкой FixMe.
  • Статьи, не начинающиеся с Eng:, должны быть написаны на правильном русском языке.
    • Старайтесь избегать перегрузки статьи техническими терминами. Если значение термина неочевидно среднему пользователю Интернета, указывайте в скобках или сноской внизу страницы его толкование. Если же его нельзя истолковать парой фраз, надо писать отдельную страницу. Если её ещё нет, просто сделайте ссылку, кто-нибудь обязательно напишет.
    • Категорически не рекомендуется употребление жаргонизмов (аська, жид и т.п.).
    • В русском языке 33 буквы! С недавних пор написание «Е» вместо «Ё» считается ошибкой. Будьте так добры, уважайте свой (ну или хотя бы мой) язык, расставляёте точки над «Ё»!
    • Советую полистать школьные учебники и освежить в памяти правила пунктуации, в том числе правила постановки знака «—» (тире). Чтобы избежать проблем, создаваемых обилием кириллических кодировок и не всегда совместимых браузеров, ставьте тире как &mdash;
    • Не используйте в русскоязычных текстах английских кавычек ("). Юникод умеет наши, русские кавычки. Соответствующие HTML-коды: &laquo; для « и &raquo; для »
  • Следите за структурой статьи. Оглавление создаётся автоматически на основе использованных в тексте заголовков.
    • Если требуется озаглавить страницу по-русски, то согласно правилам, непосредственно имя следует написать по-английски, но русскоязычное название рекомендуется указать в начале самой страниче в виде
      <big>'''Название страницы'''</big>
  • Минимизируйте использование HTML-тэгов <table>, <i>, <b>, <img>, <h[1-6]>, <a> в тексте страницы.
    • Таблицы оформляются так:
       {|
        | строка 1, ячейка 1
        | строка 1, ячейка 2
        |-
        | строка 2, ячейка 1
        | строка 2, ячейка 2
        |-
        | строка 3, ячейка 1
        | строка 3, ячейка 2
        |}
    • Рисунки подписывайте
      [[Image:адрес_рисунка|thumb|Подпись к рисунку. Внутри подписи можно использовать [[ссылки]] и ''другие'' элементы форматирования]]
    • Начинать иерархию заголовков лучше сразу со второго уровня (== Заголовок ==).
Retrieved from "http://wiki.jrudevels.org/index.php?title=JaWiki:Advices&oldid=4249"