Распространение вашей документации

Перед тем как начать распространение

Перед тем, как вы предложите ваш код миллионам потенциальных читателей, есть несколько вещей, которые нужно сделать.

Прежде всего, убедитесь, что вы проверили правописание вашего документа. Большинство утилит, которые используются для написания SGML имеют плагины для проверки орфографии. Если нет, вы всегда можете воспользоваться программой aspell.

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

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

Проверьте ваш SGML код

Используя sgmltools, вернее команду nsgmls, вы можете проверить ваш .sgml код на соответвие DTD, чтобы убедиться что он не содержит ошибок.

nsgmls -s HOWTO-HOWTO.sgml
   

Если ошибок не встречено, вам просто будет возвращена командная строка.

Права и лицензирование

Чтобы ваш документ был принят LDP, он должен быть залицензирован так, чтобы разрешить его свободное (в смысле пива :)) распространение и публикацию. Как автор, вы можете удерживать копирайт и добавлять другие ограничения (например потребовать чтобы работы основанные на вашей или переводы были одобрены вами). Пример лицензии вы можете найти по адресу http://www.linuxdoc.org/COPYRIGHT.html. Если вы выберите полномасштабный копирайт, просто скопируйте его в исходный код в секцию "Copyright and Licenses" или подобную её. Также включите ваш собственный копирайт (так как вы все таки владелец документа). Если вы продолжаете чьё-то HOWTO вы обязаны включить заметки о копирайте приведущих авторов и даты, когда они занимались документом.

Опубликование в LDP

После того как ваш документ был просмотрен несколькими людьми, и были приняты во внимание их замечания, вы можете опубликовать его в рамках LDP. Пошлите e-mail с SGML кодом в качестве вложения (можете сжать его gzip, если хотите) по адресу ldp-submit@lists.linuxdoc.org.

Обязательно включите название вашего HOWTO в строке тема, в теле письма отметьте сделанные изменения и приложите к письму ваше HOWTO. Это позволить людям занимающимся HOWTO, сделать свою работу быстрее и вам не придется ждать, пока ваше HOWTO будет обновлено на веб сайте LDP. Если вы не услышите ничего в течении 7 календарных дней, пошлите письмо, чтобы убедиться, что работа идет.

Стили написания

Эта секция описывает некоторые соглашения, которые были приняты LDP, чтобы сделать все LDP документы похожими друг на друга. Вы должны помнить их, когда будете писать документ.

Форматы дат

Тэг <date> в заголовке вашего документа должен иметь следующий формат:

v1.0, 21 Апрель 2000