{"meta":{"title":"Создание переключателей инструментов в статьях","intro":"Вы можете использовать переключатель инструментов, чтобы показать, как выполнять задачи с помощью определенных средств.","product":"Участие в документации GitHub","breadcrumbs":[{"href":"/ru/enterprise-server@3.17/contributing","title":"Участие в документации GitHub"},{"href":"/ru/enterprise-server@3.17/contributing/writing-for-github-docs","title":"Написание для GitHub Docs"},{"href":"/ru/enterprise-server@3.17/contributing/writing-for-github-docs/creating-tool-switchers-in-articles","title":"Создание переключателей инструментов"}],"documentType":"article"},"body":"# Создание переключателей инструментов в статьях\n\nВы можете использовать переключатель инструментов, чтобы показать, как выполнять задачи с помощью определенных средств.\n\n## Сведения о переключателях инструментов\n\nВ некоторых статьях мы записываем содержимое, адаптированное к различным средствам (пользовательский интерфейс GitHub, GitHub CLI, GitHub Desktop, cURL, Codespaces, VS Code, API GraphQL и т. д.) Переключатель инструментов позволяет пользователям выбирать инструмент, чтобы увидеть только содержимое, соответствующее этому инструменту, так как средства могут иметь различные концептуальные или процедурные сведения.\n\n![Снимок экрана: переключатели инструментов в статье. Переключатели инструментов указываются с темно-оранжевым контуром.](/assets/images/contributing/tool-switchers.png)\n\nПользователи могут использовать переключатель инструментов двумя способами при чтении документации.\n\n* **Изучение** . Для задач, которые можно выполнить с различными инструментами, средство переключает сигналы людям о том, что можно выполнить задачу несколькими способами. Например, использование GitHub CLI или GitHub Desktopвместо пользовательского интерфейса GitHub.\n\n* **Переход к точке** . Когда кто-то знает, как они хотят выполнить задачу и не нужно видеть дополнительные параметры, переключатель инструментов удаляет менее релевантное содержимое, чтобы они могли найти именно то, что им нужно.\n\n## Использование тегов инструментов\n\nВы можете добавить переключатели инструментов в статью с помощью тегов инструментов в Markdown. Теги инструментов — это теги Liquid, которые содержат содержимое, которое нужно отобразить на определенной вкладке переключателя инструментов.\n\nНапример, в следующем блоке кода отображается содержимое для трех различных инструментов.\n\n```markdown\n{% vscode %}\nThis content is specific to Visual Studio Code.\n{% endvscode %}\n\n{% visualstudio %}\nThis content is specific to Visual Studio.\n{% endvisualstudio %}\n\n{% jetbrains %}\nThis content is specific to JetBrains IDEs.\n{% endjetbrains %}\n```\n\nПо умолчанию первый тег средства, используемый в Markdown, будет выбран для статьи. Вы можете определить другое средство по умолчанию для статьи, указав `defaultTool:` свойство в интерфейсном элементе статьи. Дополнительные сведения см. в содержимом [README](https://github.com/github/docs/blob/main/content/README.md#defaulttool).\n\nВы также можете связаться со статьей с определенным средством, выбранным путем добавления `?tool=TOOLNAME` в конец ссылки. Дополнительные сведения см. в разделе [Руководство по стилю](/ru/enterprise-server@3.17/contributing/style-guide-and-content-model/style-guide#links-to-a-specific-tool).\n\nВ статью входит только не более восьми различных инструментов. Включение дополнительных инструментов приводит к переполнению вкладок переключателя инструментов с оглавлением статьи, что запрещает пользователям использовать переключатель инструментов или оглавление. Вряд ли вам потребуется включить восемь отдельных инструментов в статью. Как правило, планируйте использовать как можно меньше отдельных инструментов в статье.\n\n### Когда следует использовать теги инструментов\n\nМы используем только теги инструментов, если в статье должны быть сведения, относящиеся к инструменту, чтобы помочь людям выполнять свои задачи.\n\nНе используйте переключатель инструментов только для отображения примеров на разных языках. Используйте переключатель инструментов только в том случае, если задачи или понятия, описанные в статье, изменяются на основе того, какой инструмент использует кто-то.\n\n## Добавление новых инструментов\n\nGitHub Docs документы и поддерживает теги инструментов для продуктов GitHub, GitHub, разработанных средствами, и выбирают сторонние расширения, разработанные в сотрудничестве с GitHub .\n\nНовые инструменты добавляются только в том случае, если они являются единственным способом точно документировать что-то для конкретного пользователя. Если средство записи определяет, что добавление нового инструмента является единственным способом точно документировать что-то, им нужно предложить новое средство в плане разработки контента. Независимо от того, кто проверяет план разработки контента, следует рассмотреть любые альтернативные способы решения потребностей документации без добавления нового инструмента. Если новое средство является единственным способом создания точной документации, необходимо добавить новое средство. Если существует альтернативное решение для содержимого, которое не добавляет новое средство, этот параметр следует использовать.\n\nЧтобы добавить новое средство, добавьте запись в `allTools` объект в файле в [`lib/all-tools.ts`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.ts) виде пары \"ключ-значение\". Ключ — это тег, используемый для ссылки на инструмент в статье, и значение заключается в том, как средство будет идентифицировано в средстве выбора в верхней части статьи. Например, `vscode: 'Visual Studio Code'`.\n\nДобавьте новые инструменты в алфавитном порядке."}