DecimalWiki:Памятка для авторов

Материал из Decimal Wiki
Перейти к навигации Перейти к поиску

Это развивающееся руководство о том, как внести свой вклад в Decimal Wiki и над чем работать.

Целью Decimal Wiki является создание и поддержка аккуратного, обновляемого, завершённого и лёгкого в использовании справочника для всех, кто интересуется блокчейном Decimal и сферой криптоэкономики в целом. Присоединяйтесь к нашему проекту! Чтобы создавать и редактировать статьи, вам необходимо зарегистрироваться.

Как здесь редактировать

Нажмите ссылку «Править» в верхней части страницы. Откроется страница редактирования с текстом статьи и особыми символами — «вики-разметкой».

Внесите желаемые изменения в исходный текст.

Кратко опишите смысл своей правки в строке «Описание изменений».

Для проверки правильного отображения страницы нажмите кнопку «Предварительный просмотр».

Если со страницей всё в порядке, опубликуйте свою новую версию нажатием кнопки «Записать страницу».

Быстрые советы

  • Тон статьи должен быть информативным и полу-профессиональным. Используйте третье лицо (напр., «криптоинвесторы», «участники рынка») в вводной части статьи. Вы можете использовать второе лицо в последующих параграфах и предложениях, но старайтесь не писать от первого лица.
  • Длина страницы или раздела должна быть настолько велика, насколько требуется, но не больше; статья должна быть информативной и сжатой.
  • Используйте форматирование текста (напр., жирное начертание, курсив) умеренно. Старайтесь не использовать цветной текст, зачеркивание, подчеркивание.
  • Соблюдайте правописание русского языка. Пишите полными предложениями, за исключением таблиц.
  • Добавляйте в текст соответствующие внутренние и внешние ссылки.
  • Добавляйте категории в статьи, если очевидная/полезная категория отсутствует. Проверьте страницу категорий, чтобы узнать, какую категорию можно добавить на страницу, и воздержитесь от создания категорий, которые не используются.
  • После внесения изменений, укажите в специальном поле снизу, что вы изменили. Это поможет остальным редакторам проверить вашу работу
  • Переименование страниц допустимо только в случае крайней необходимости. Если вы считаете, что это необходимо, оставьте соответствующий запрос к администраторам на странице обсуждения статьи.
  • Если вы считаете, что страница должна быть удалена, оставьте соответствующий запрос к администраторам на странице обсуждения статьи или поставьте на странице шаблон {{delete|Причина удаления}}; укажите причину удаления.

С чего начать

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

После регистрации не стесняйтесь заполнить страницу своего профиля некоторой информацией о себе. Давайте познакомимся с вами!

Если вам нужна помощь в редактировании, прочтите это пособие.

О чём писать

Наполнение вики — это не просто создание абсолютно новых страниц; это также поддержание качества существующих.

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

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

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

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

Просмотр и (при необходимости) редактирование или удаление спекулятивного контента помогает сохранить точность вики.

Подписка на правки

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

Если вы хотите следить за изменениями в этой вики или следить за новыми пользователями и редакторами, используйте «последние изменения».

Стиль

Тон

Тон статьи должен быть информативным и полупрофессиональным. Basically, this means opening all articles with clear-cut and concise definitions of the topic in question, followed by a well-organized and thorough rundown of the topic in detail. Stick with the third person only in the openings, using words like «player» and «user» rather than «you.» Once you get into the meat of an article, it should be fine to use the second person, as most articles will have instructions for users of the site to follow. Never use the first person under any circumstances. Writing in all caps is considered yelling, and as such it is an improper tone for this Wiki.


Длина статьи

The article should be straight to the point and only as long as needed (especially for broader topics). However, do not go on a tangent and add fluff. Shorter articles are generally more accessible and usable than really long ones. Referencing related pages, however, is recommended and helpful for users in general. Always write the best that you can on all of your contributions.


Форматирование

Текст

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

Отступы

Поля и отступы — это названия пространства вокруг элемента, будь то текст, изображение, таблица и т. д. Как редактору вики, вам обычно не нужно беспокоиться об этом. Когда вы углубитесь в это, это можно будет сделать с помощью CSS и атрибута style. Подробнее об использовании вы можете прочитать здесь: margins и padding.

Правописание

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

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

Заглавные (прописные) буквы

Написание с прописной буквы отдельного слова неформально называется капитализация (англ. capitalization).

Обычно рекомендуется писать с прописной буквы только первое слово названия, а также имена собственные (Москва, Decimal), входящие в название. Это не строгое правило. Нередки случая, когда из маркетинговых (или иных) соображений название продукта целиком пишется прописными — очень часто это касается названий монет в нашем блокчейне.

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

Заглавные буквы в заголовках и подзаголовках соответствуют русским, а не английским правилам: Пример подзаголовка статьи в Decimal Wiki, а не Пример Подзаголовка Статьи в Decimal Wiki.

В самом тексте, а также в обсуждении статей избегайте использовать CAPS LOCK. Запись КРУПНЫМИ буквами воспринимается как крик и считается неприличным тоном в интернет-среде.

Ссылки

Relevant internal links to articles help readers browse the wiki and help avoid dead-end pages. External links to GitHub issues and Trello cards can provide useful behind the scenes or historical information. Do not link to wiki pages that do not currently exist as the Habitica Wiki avoids using broken links.


When creating links on a page, make sure that you link to the current page for the topic in question, and that the target link in the source code (or edit link box) is appropriately capitalized.


You can add internal links by putting double square brackets around text designating the title of the page you want to link to. For example, [[Gold Points]] becomes Gold Points. You can also use a vertical bar (|) to customize the link title. For example, typing [[Gold Points|gold]] will produce gold. You can add external links by placing the URL within single square brackets. For example, [http://www.tablesgenerator.com/mediawiki_tables TablesGenerator.com] becomes TablesGenerator.com. Note the use of a space (not a bar |) to separate the URL from the optional link text.


Because the wiki is a work in progress, pages are occasionally consolidated, removed, or renamed. For example, the Gold Points page has previously been named Gold Points (GP) and Gold Coins. To prevent issues when other sites have linked to the pages on the wiki that no longer exist, the admins leave redirect links to deleted pages. This means that when new internal links are created, the auto-fill suggestion box includes these old link names. When wiki users click these old links, they are redirected to the new page. The new page alerts the user to the old link redirect with a message below the page title, «Redirected from [old page name]», as can be seen using the links in the above example. Link targets that are not capitalized in the source code also give this message. This issue does not affect functionality of the wiki, but using the correct link and preventing these messages improves the wiki’s sense of professionalism.


Заголовки разделов

Liberal use of headers breaks up articles, enables easier reading, and allows the automatic generation of tables of contents. However, too many subheadings makes the text harder to read, especially if related content is being broken up unnecessarily. To keep text easy to follow, try to strike a balance in the number of headings used.


Headers and subheadings should not be changed unnecessarily. They can be linked to from other pages and from locations outside the wiki (e.g., Habitica itself, GitHub, and blog posts) so any change to a heading will make these links nonfunctional. If it is essential to change a header, correct all links leading there from elsewhere in the Habitica wiki. Also, search likely locations in the Habitica website (habitica.com) for links to the heading. If you find any, create a new issue in GitHub to ask that the link be changed.


Headers and subheadings are capitalized according to the rules described in Composition titles (a form of title case). However, if you see an existing header that does not have correct capitalization, please do not change it unless you are certain that there are no links to it.


Содержание (TOC)

The table of contents (TOC) will automatically generate after the fourth main sub-heading. The TOC can be forced to appear with less than four sub-headings by including the following code in the source view of the editor at the start of the wiki document: __TOC__ To shift the TOC to the right of the page, enter the following code into the source view of the editor at the top of the wiki document:


Изображения

Images should be added if they are useful in the context of the article, for example, if they help make a concept more clear, with the exception of the Whats New pages which should match the Bailey announcements in old news.


Before uploading a new image, search for it in Special:Images and in the various Images categories. The image you want might already be uploaded and if so, you should not upload a duplicate (see Replacing v. Deleting below for more information). If it has not already been uploaded, you can find most of the original Habitica images used on the website (including items, food, pets, and mounts) in GitHub under the website/assets/sprites/spritesmith and website/assets/sprites/spritesmith_large directories in the «habitrpg» repository.


Типы файлов

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


Авторское право

Видео

Videos from Youtube and Vimeo can be included, but should only be used if they improve the article significantly.


Категории

Categories can be added to articles to group them according to a certain topic. However, having too many categories, especially when they contain very few pages, have vague topics, or are similar to other categories, can add unnecessary clutter to the wiki and make it more difficult for users to find the most helpful categories. Please refrain from adding categories that are not already in use without first discussing your idea with other experienced Scribes, such as in the Wizard of the Wiki guild.


Category pages (for example, Категория:Contributing) can optionally contain one to two sentences to explain what the category is for. This is not necessary when the intention is obvious. Category pages should never contain more content than that because their primary purpose is to be a list of related articles. Check the page for a category before adding articles to the category, since it may contain guidance about what pages should or should not be added.


Most categories are reserved for certain types of pages--in particular, the categories listed in the Category Index should only be used for main wiki pages, unless noted otherwise (e.g. Категория:Guilds and Категория:Parties are for pages in the Armory). To avoid clutter, please don’t add these categories to other types of pages (templates, blog posts, files, etc.).


Описание изменений

When making edits, write a short summary of the changes that have been made in the 'Edit Summary' box before publishing. Depending on the edit, a few words may suffice, but major edits may need longer summaries or the inclusion of rationales. Providing these summaries allows other scribes to quickly get a sense of what has changed. It is also extremely helpful when filling out contributor tier applications, as these summaries are shown as part of the edit histories on user profiles in the 'Contributions' tab. In addition, it makes finding specific changes in a series of edits much easier.


If you have trouble remembering to fill out the edit summary, you can (if you have an account) set your user preferences to remind you if you forget to leave one. In the «Editing» section of your preferences, check the box reading «Prompt me if I leave a blank edit summary» (the third checkbox under «Editing experience») and save the change. This will remind you to fill in your edit summary if you leave it blank on any page (except your own user page) on any Wikia wiki. If your edit summary is blank and you click «Publish» you will be given a reminder reading «Reminder: You have not provided an edit summary. If you click Publish again, your edit will be published without one». You then have the option to type an edit summary as recommended or just save your edit without one.


Переименование страниц

On rare occasions, pages may need to be renamed. When pages are renamed, Wikia will automatically create a redirect page that will take old links to the new site. However, links on the wiki will not be updated automatically. The wiki will still function, but users will be alerted to the fact that the link is old with a message below the page title, «Redirected from [old page name]». To eliminate this message and maintain the sense of professionalism that the wiki strives for, you can use the special page WhatLinksHere to find those out of date links that renaming has created, and fix them. Simply type the old page title into the appropriate box, and they will be displayed.


Удаление

Есть случаи, когда страницы могут быть переименованы, также были случаи, когда страницы будут удалены. Только администраторы вики могут удалять страницы. Если вы считаете, что страница должна быть удалена, откройте классический редактор, а затем вкладку «Исходный код». В верхней части страницы добавьте следующий код с указанием причины для удаления:


{{delete|Reason for deletion}}

Keep in mind that at this time, redirect pages are a permanent fixture for the wiki. The wiki is here to provide information to the users in a way that’s convenient for them to use. Broken external links, whether from an outside site, the Habitica forums, or a page that a user bookmarked, make it less convenient for the readers to use the wiki. Therefore, redirect pages are kept in place so that these links will not give a «404 Page Not Found» error. This ensures that wiki users have a better experience when trying to locate information, and increases the wiki’s efficiency in providing consistent, up-to-date information. Remember, our goal is to create and maintain an accurate, up-to-date and easy-to-use guide for players of Habitica, so if there is a redirect page that you firmly feel needs to be deleted, at the top of the page add the deletion code with the reason that the page should be deleted. From there, the wiki admins will discuss the reason and make a decision, and the page will either be deleted, or the deletion code can be removed.


Создание песочницы пользователя

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


1. Go to your user page. You can do this by clicking on your user icon at the top right of any wiki page. You may have to click twice if the first click opens up the menu.


2. Add /Sandbox to the end of your URL. Click on the URL box in your browser, deselect the text, and type in /Sandbox at the very end of. Go to this page.


3. Since you have not yet created your sandbox, you will have the option to do so here. Right next to the page title, click the Create button.


4. If it opens up in the visual editor, select the option to open the source editor. You can find this option by clicking on the drop-down menu next to the Cancel and Publish buttons, and selecting Source Editor.


5. Paste the following code into the text box:

{{Sandbox}}

                                      <!--EDIT BELOW THIS LINE-->

6. Below this pasted text, you can begin to practice editing. One idea to begin with is to add a table of contents and links to useful templates and code that you often need to look up.


7. Whenever you are finished editing in the source editor, click Apply Changes on the bottom right of the frame.


8. Click on Publish to save your page.


9. To find your Sandbox easily, add a link to it on your profile page. You can do so by pasting the following code into the source editor of your user page (found by clicking on your user icon, selecting Edit Profile under the Profile tab, and selecting the Source Editor option), replacing «Username» with your own username:

[[User:Username/Sandbox|My Sandbox]]

10. Voila! You now have a Sandbox of your own! Experiment with it as you please!


Другие советы по аккаунту вики

Файл:Wiki Toolbar customize default.jpg
Wiki Toolbar


Панель инструментов

Файл:Wiki Toolbar customize dialog.jpg
Customization Dialog

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


Список доступных инструментов панели инструментов см. на этой странице.


Файл:DisablingAdsWikiaAccount.png
Disabling Ads on the Wiki

Шаблон:Clr

Отключение рекламы

Если у вас есть учетная запись Wiki и вы хотите отключить рекламу, вы можете перейти на страницу настроек, прокрутить вниз до объявлений и выбрать «Не показывать все объявления», а затем сохранить свои настройки.


Обновление страниц

Иногда страницы могут вести себя странно, как будто не показываются изменения. Если это происходит, попробуйте добавить ?action=purge в конец URL-адреса и перейти по этому адресу. Это приведёт к перезагрузке страницы и устранению многих проблем. -->