Вести работу над статьями рекомендуется на компьютере, так как на мобильных устройствах могут наблюдаться проблемы.
#### Рекомендации по написанию статей - Не создавайте [книги и главы](#bkmrk-shelves%2C-books%2C-chap) для одной-двух страниц. Излишняя вложенность затрудняет поиск информации. - Используйте [заголовки](#bkmrk-%D0%97%D0%B0%D0%B3%D0%BE%D0%BB%D0%BE%D0%B2%D0%BA%D0%B8%3A). Это улучшает работу поиска по сайту, облегчает навигацию по тексту и позволяет логически разделить текст. - Используйте [форматирование](#bkmrk-%D0%A8%D1%80%D0%B8%D1%84%D1%82%D1%8B%3A) текста. Это облегчает его восприятия и повышает концентрацию читателя. - Не публикуйте недописанные статьи. В случае, если вы набросали черновик, вместо публикации сохраните его как черновик. Меню управления черновиками находится над окном редактора текста. По мере набора текста происходит автоматическое сохранение. - [](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/mZdHBE96ycly7OiK-image-1642168311849.png)Старайтесь чётко и ясно структурировать мысли. Избегайте использования жаргонной лексики за исключением моментов, когда жаргон является общеизвестным или касается тематики электротранспорта. На потенциально незнакомые читателю слова оставляйте ссылку в [глоссарий](https://scooter-wiki.scribable.icu/books/kugoo-g2-pro-obshhee/page/glossarii "Глоссарий"). Со способами добавить ссылку можно ознакомиться [ниже](#bkmrk-%D0%A1%D1%81%D1%8B%D0%BB%D0%BA%D0%B8). - В случае добавления ссылок на внешние ресурсы, корректно обозначайте их текстом, в случае ссылок на приобретение товаров, оставляйте фото приобретаемого товара. Также рекомендуется оставлять [подпись](#bkmrk-%D0%9F%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D1%8C-%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B8) к ссылке. Всё это поможет читателю найти описываемый предмет или тему в случае, если используемая ссылка потеряет актуальность. - При редактировании чужой статьи указывайте список изменений. Это поможет в разрешении спорных ситуаций и препятствию [войне правок](https://lurkmore.to/%D0%92%D0%BE%D0%B9%D0%BD%D0%B0_%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D0%BA "Lurkmore. Война правок.").Старайтесь создавать качественный контент. Чем больше качественных статей, тем больше авторы будут заинтересованы в дальнейшим повышении качества создаваемых ими материалов, так же и наоборот. Это является проявлением [теории забитых окон](https://ru.m.wikipedia.org/wiki/%D0%A2%D0%B5%D0%BE%D1%80%D0%B8%D1%8F_%D1%80%D0%B0%D0%B7%D0%B1%D0%B8%D1%82%D1%8B%D1%85_%D0%BE%D0%BA%D0%BE%D0%BD "WIkipedia. Теория разбитых окон.").
Материалы, созданные с нарушением описанных выше комендаций могут быть закрыты для публичного просмотра или удалены. Авторы, регулярно нарушающае данные рекомендации, могут быть органичены в создании новых публикаций.
#### Проверка орфографии Для того чтобы убедиться в соответствии написанного вами текста нормам русского языка, можно использовать спеллчеккер (программу, проверяющую текст на ошибки) Существует бесплатный спеллчеккер [LanguageTool](https://languagetool.org/), представленный в виде отдельного сайта, а также плагинов для различных приложений. [Плагин для браузера Chrome](https://chrome.google.com/webstore/detail/grammar-spell-checker-%E2%80%94-l/oldceeleldhonbafppcapldpdifcinji "Chrome webstore") [](https://lh3.googleusercontent.com/aWtP0rIATRVsZjZHBoicvGMeXImFkM4PV4LVJ3SWyJ6LFYDFjHjp2oJYZAND3HW-3Fz0Sgx9liEq2G6Ftq4OIEOO0zE=w128-h128-e365-rj-sc0x00ffffff) ## Разметка текста и оформление статей ### Shelves, Books, Chapters, pages: **Bookstack** имеет следующие сущности Шкафы, книги, главы, страницы. По сути своей это уровни вложенности, дающие возможность разграничения прав. Самый верхний уровень — шкафы. Здесь происходит глобальное разделение направленностей статей будь то разные самокаты или иные темы. Далее идут книги — разделение статей по различным темам, касающимся одного направления, например обслуживание, модернизация, личный опыт. Следующим, но не обязательным уровнем являются глав. Их можно использовать для отделения отдельных статей по тематики, как к примеру механические доработки, электрические доработки. Последним и основным уровнем являются страницы, содержащие непосредственно текст.Выбирайте раздел и уровень вложенности с умом. Не следует создавать новые книги или главы ради одной статьи.
#### ### Превью книг: Картинка на превью должна иметь разрешение 440х250. При этом 60 пикселей снизу и сверху будут не видны при стандартном отображении книг (List) и 40 пикселей снизу и сверху не будут отображаться в режиме Grid. Шаблон иконки книги для Photoshop: [Book.psd](https://wiki.scribable.ml/attachments/9) Как основной фон должна использоваться данная картинка: [BG.png](https://wiki.scribable.ml/attachments/7) Основное изображение должно визуально подходить иконкам других книг. #### ### Заголовки: Bookstack имеет 4 уровня заголовка. Заголовки обеспечивают как смысловое разделение текста, так и помогают в навигации по статье. #### ### Шрифты: В обязательном порядке должен использоваться стандартный размер текста и шрифт. При копировании текста будет также скопирован его стиль, поэтому рекомендуется сначала скопировать материал в текстовое поле, не поддерживающее форматирование, либо нажать кнопку очищения стиля ***T****x* в окне редактора Bookstack. #### ### Выделение текста: Для выделения текста может использоваться `Inline code` (Можно найти в разделе Formats), либо `Callouts`Пример Callout info
Callout Success
Callout Warning
Callout Danger
#### Общее: Для отмены выделения текста (заголовки, Callouts, цитаты) можно использовать тип текста `Paragraph` или кнопку очищения стиля ***T****x*. Для того чтобы записать несколько строк в Callout необходимо нажать клавишу Enter с зажатой клавишей Shift. #### Акценты в тексте: Элементы, на которых следует сделать акцент можно выделять с помощью **`Inline code`** с применением бордового цвета и жирного текста. #### Цитаты и прочее: > Цитаты выделяются через формат Blockquote #### ### Ссылки Ссылки внутри статьи помогают быстрее найти нужную информацию, а ссылки между статьями дают читателю возможность быстро и легко ознакомиться с описываемой в статье сущностью. Наличие ссылок позволяет значительно повысить комфорт ознакомления с материалом. #### Ссылки внутри статьи Для того чтобы добавить ссылку внутри статьи, нажмите на иконку ссылки и кликните по полю **`Url`**, после чего откроется список с имеющимися заголовками внутри статьи. [](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/WUvW5wPxHauIrUTA-image-1642168987185.png) #### Ссылки между статьями Для того чтобы добавить ссылку между статьями, нажмите на иконку ссылки, кликните по иконке с папкой и лупой. В открывшемся окне при помощи поиска найдите необходимую статью. ##### [](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/BVWPZIUwE2dzXmZU-image-1642169244395.png) #### Ссылки на заголовок внутри другой статьи К сожалению, удобного способа оставить ссылку на заголовок в другой статье нет. Это придётся делать вручную. 1. Откройте статью на заголовок которой вам нужна ссылка. 2. В меню навигации (слева) найдите ссылку на нужный заголовок. 3. Нажмите по ссылке правой кнопкой мыши и скопируйте её.[](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/AtvNiAgGJtvYksRe-image-1642169701994.png) 4. Вернитесь в редактор текста правящейся статьи 5. В редакторе нажмите на иконку ссылки и в поле **`Url`** вставьте скопированную ссылку. [](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/EF8NeorWR0cEKxQz-image-1642169760285.png) ##### ##### Ссылки к конкретным моментам в статье К сожалению, ссылки к конкретным словам можно добавлять тоже только вручную. Действуйте аналогично добавлению ссылок на заголовок другой статьи, а для получения ссылки к нужному моменту, выделите нужное слово, например дважды кликнув по нему левой кнопкой мыши, откроется выпадающее меню с ссылкой на данный элемент статьи. [](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/5K9opa76398YkIL7-image-1642171493348.png) ##### Подпись ссылки Чтобы добавить подпись на ссылку, которая отобразится при наведении курсора, заполните поле **`Title`** при добавлении ссылки. [](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/bXvNjQMeznlMgiv3-image-1642170075316.png) [](https://scooter-wiki.scribable.icu/uploads/images/gallery/2022-01/W80vFHE8TOPCBawY-image-1642170057122.png) #### Спойлеры К сожалению, на данный момент редактор не позволяет создать спойлер через графический интерфейс. Для того чтобы убрать контент под спойлер, необходимо открыть код страницы и добавить следующие теги: ```HTML