Для удобства совместной работы а также для улучшения качества контента мы просим вас соблюдать следующие правила при создании и написании статей.
- Перед созданием страницы убедитесь, что создаете ее в правильно месте. Если сомневаетесь, ознакомьтесь со структурой страниц Вики
- При создании страницы по возможности выбирайте краткие и понятные названия, чтобы не затруднять навигацию.
- При создании страниц не задавайте папкам и страницам русскоязычные названия и названия, написанные транслитом. Как надо:
/somefolder/docs/mypage. Как не надо: /документация/сервис/моястраница, /dokumentatsiya/moyastranintsa.
- При создании страницы выбирайте визуальный редактор или редактор Markdown. Такие страницы гораздо проще редактировать людям, не знакомым с веб разработкой и движком Wiki. Не смотря на то что для создания доступен редактор HTML, его рекомендуется использовать только в тех случаях, когда на странице необходимо разместить какой-либо нестандартный контент или встроить iframe.
- Для вставки ссылок на страницы Wiki используйте относительные ссылки такие как
/docs вместо абсолютных, таких как https://wiki.miem.hse.ru/docs
- При создании основной страницы в папке, размещайте в ней содержание этой папки, используя список ссылок и директиву
{.links-list}
- При вставке картинок используйте следующую конструкцию:
<p align="center">
<img width="<size>" src="/path/to/image.png">
</p>
Это позволит разместить картинку по центру, а также задать ее размер в зависимости от <size>. Старайтесь не делать картинки очень большими, так как крупные изображения а также их большое число на странице снижают информативность статей и затрудняют их чтение.
- При вставке картинок и ifame-ов используйте относительные размеры и учитывайте, что у других пользователей могут быть дисплеи с другим разрешением или соотношением сторон.
- При загрузке картинок и других ресурсов старайтесь задавать им понятные названия и размещать их по папкам. Это упростит доступ к этим ресурсам в дальнейшем.
- Не занимайтесь вандализмом! Все ваши правки видны другим участникам, в том числе и администраторам.
- Если вам интересно протестировать возможности Markdown, вы можете воспользоваться предпросмотром или создать страницу в разделе test.
По всем вопросам вы всегда можете обратиться в Техподдержку или в чат #370