Как написать и ссылаться на запись в словаре

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

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

Как писать записи

Для начала новой записи, просто откройте следующую кнопку в новой вкладке, и следуйте инструкциям снизу кнопки:

Шаг 1: Напиши краткое содержание

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

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

Ссылки на глоссарий будут использовать эти резюме внутри их вкладки, так что читатели могут увидеть определения без перехода на другую страницу. (См. ниже как вставить ссылки на элементы глоссария с {{Глоссарий}} макрос.)

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

Шаг 2: Расширь с помощью ссылок

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

Мы рекомендуем Вам сортировать ссылки по крайней мере этих трех групп:

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

Технический справочник
Ссылки на более подробную техническую информацию, на MDN  или в другом месте.

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

Предлагаемые условия

Итак, Вы хотите внести свой вклад, но Вы не знаете, какие условия должны быть определены? Вот список предложений. Выберите один из них и начните!

Работа со значениями

Иногда термин имеет несколько значений в зависимости от контекста. Чтобы устранить двусмысленности, вы должны следовать этим рекомендациям:

  • The term's main page must be a disambiguation page containing the GlossaryDisambiguation macro.
  • The term has subpages that define the term for a given context.

Let's illustrate that with an example. The term signature can have different meanings in at least three different contexts: security, function and email.

  1. The page Glossary/Signature is the disambiguation page with the GlossaryDisambiguation macro.
  2. The page Glossary/Signature/Security is the page defining a signature in a security context.
  3. The page Glossary/Signature/Function is the page defining a function signature.
  4. The page Glossary/Signature/Email is the page defining email signature.

Как использовать {{Glossary}} macro

Глоссарий полезнее, если люди могут получить доступ к определениям из других документов, не переходя из того места, которое они читают. Поэтому мы настоятельно рекомендуем ссылаться на глоссарий всегда, когда это возможно. Для этого исопльзуйте макрос Glossary:

Macro Result Note
{{Glossary("browser")}} browser When a text matches the term to be defined, just use the macro as is (it's case insensitive)
{{Glossary("browser", "Web browser")}} Web browser To display an alternative text, use the second argument to specify that text
{{Glossary("browser", "Web browser", 1)}} Web browser Specify 1 as an optional third argument to display the link as a regular link rather than a subtle hint

Ссылки, созданные с помощью макроса {{Glossary}}, отображаются в виде всплывающей подсказки, содержащей соответствующий абзац глоссария.

Рекомендации по использованию

Во многих случаях, совершенно безопасно использовтаь макрос на MDN. Однако есть несколько случаев, когда нужно использовать его с острожностью:

  • If a term is already linked to another part of MDN, leave it that way and do not use the {{Glossary}} macro.
  • Within an article section, use the {{Glossary}} macro only once for the same term (hint: a section always starts with a title).

Метки документа и участники

Внесли вклад в эту страницу: MaryoneFrolova, chrootsu, bracket, MuradAz
Обновлялась последний раз: MaryoneFrolova,