Руководство · 3 min read · Oct 07, 2025
Руководство по форматированию учебников
Руководство по форматированию учебников
Версия 1.3
Если вы хотите опубликовать учебник на HowtoForge, пожалуйста, прочитайте это руководство, чтобы узнать, как форматировать ваш учебник так, чтобы он соответствовал стилю HowtoForge и выглядел привлекательно для как можно большего числа читателей. Эти рекомендации также помогут вам минимизировать размер вашего документа.
1 Какую программу я использую для написания своего HowTo?
Используйте HTML-редактор, такой как Dreamweaver, или бесплатную альтернативу Bluegriffon http://www.bluegriffon.org/ или любой другой HTML-редактор, который создает корректный HTML. Не используйте MS Word для создания HTML-контента, потому что Word создает “странный” HTML…
2 Как мне начать?
Хорошо, вы сидите перед своим HTML-редактором, готовые начать, но что дальше? Пожалуйста, скопируйте этот HTML-скелет в ваш редактор:
| |
Теперь вы пишете свой учебник между тегами
и .3 Форматирование
3.1 Обычный текст
Всегда используйте шрифт по умолчанию для обычного текста и заголовков! Не используйте теги , и не определяйте свои собственные CSS-классы. Все форматирование будет выполнено с помощью CSS-классов HowtoForge после того, как вы опубликуете свой учебник на HowtoForge.
Например, что-то вроде
Это предложение.
должно быть избегнуто. Просто используйте
Это предложение.
вместо этого. На HowtoForge это будет выглядеть так:
Это предложение.
3.2 Заголовки
Пожалуйста, используйте
…
,…
,…
,…
или…
для форматирования заголовков. Снова, не используйте теги или CSS-классы для их форматирования.Заголовок
Это заголовок
будет выглядеть так на HowtoForge:
Это заголовок
3.3 Команды
Пожалуйста, используйте CSS-класс .command (определенный в секции
… в HTML-скелете) для форматирования команд оболочки, чтобы читатель знал, что это то, что он должен выполнить в оболочке. Например,chmod 755 /path/to/file
будет выглядеть так на HowtoForge:
chmod 755 /path/to/file3.4 Содержимое файлов
Содержимое файлов должно быть заключено в
…. Например, если вы хотите показать вашим читателям содержимое /etc/resolv.conf, вы делаете это так:
search server
nameserver 145.253.2.75
nameserver 193.174.32.18
nameserver 194.25.0.60
Это будет выглядеть так на HowtoForge:
search server
nameserver 145.253.2.75
nameserver 193.174.32.18
nameserver 194.25.0.603.5 Имена файлов, имена протоколов, системные спецификации, технические спецификации и т. д.
Если вы пишете о предметах, связанных с системой Linux, которые не являются командами, но которые вы хотите отформатировать особым образом, тем не менее, вы можете использовать CSS-класс .system. Например, если вы упоминаете имя файла в обычном тексте, будет хорошей идеей отформатировать его так:
Далее мы редактируем /etc/network/interfaces, чтобы он выглядел так:...
На HowtoForge это будет выглядеть так:
Далее мы редактируем /etc/network/interfaces, чтобы он выглядел так:…
3.6 Выделение
Если вы хотите выделить что-то, вы можете использовать CSS-класс .highlight. Например,
server1:
выглядит так:
server1:
5 Изображения
Пожалуйста, не используйте изображения, которые превышают 550 пикселей в ширину!
4 Опубликуйте свой учебник
Пожалуйста, упакуйте ваш учебник (HTML-файл, созданный в соответствии с главами 1 - 3) вместе с изображениями и отправьте zip-файл на [email protected]. Пожалуйста, укажите ваше имя пользователя HowtoForge в письме, чтобы мы могли опубликовать учебник под вашим именем.
6 Одобрение администратора
Ваш новый учебник не будет доступен для публики сразу. Один из наших администраторов проверит его (форматирование, содержание и т. д.), и, скорее всего, ваш учебник будет одобрен. После этого он будет доступен на HowtoForge.
Get new posts in your inbox
No spam. Unsubscribe anytime.