Правила пользования и участия в разработке на сайте Gentoo.ru

Автор-составитель: Таблеткин Дмитрий

Содержание
1. Общие положения
2. О разработке документации
2.1. Разметка документов в html

1. Общие положения

Этот сайт целиков и полностью посвещен свободной операционной системе Gentoo Linux, однако мы не являемся официальным сайтом. Поддержание сайта - это наше общее хобби и будет очень приятно, если кому-то понравится наша затея и он внесет небольшой вклад в развитие проекта. Нам нужны переводчики для переводов англоязычной документации, лингвисты для отслеживания стлистических и прочих ошибок и недочетов, программисты и системные администраторы для помощи в разборе спорных вопросов, а так же обычные пользователи для конструктивной критики

2. О разработке документации

Пока есть возможность размечать документацию только в html, а позже скорее всего появиться возможность в xml

2.1. Разметка документов в html

Для этих целей рекомендуем использовать свободный редактор Quanta Plus. Его можно получить с сайта http://quanta.sourceforge.net или для пользователей Gentoo Linux выполнить

emerge kde-base/quanta

Сохранять необходимо в кодироке UTF-8 (Unicode). Теперь непосредственно о разметке.

2.2. Начало документа

Писать начальные теги html не надо, это сделает сам сайт, можно сразу перейти к форматированию документа.

2.2.1. Автор и описание

Строка для имени автра выглядит так:

Автор: Имя и фамилия автора

Укажите автра или авторов, которые имеют отношение к данному докумету, а так же их почтовые адреса. Во избежание спама рекомендуем скрывать e-mail с помощью небольшого Python-скрипта:

#! /usr/bin/env python

import sys

chars = {'-': '-', '.': '.', ':': ':', '_': '_',
                 '0': '0', '1': '1', '2': '2', '3': '3',
                 '4': '4', '5': '5', '6': '6', '7': '7',
                 '8': '8', '9': '9', '@': '@', 'A': 'A',
                 'B': 'B', 'C': 'C', 'D': 'D', 'E': 'E',
                 'F': 'F', 'G': 'G', 'H': 'H', 'I': 'I',
                 'J': 'J', 'K': 'K', 'L': 'L', 'M': 'M',
                 'N': 'N', 'O': 'O', 'P': 'P', 'Q': 'Q',
                 'R': 'R', 'S': 'S', 'T': 'T', 'U': 'U',
                 'V': 'V', 'W': 'W', 'X': 'X', 'Y': 'Y',
                 'Z': 'Z', 'a': 'a', 'b': 'b', 'c': 'c',
                 'd': 'd', 'e': 'e', 'f': 'f', 'g': 'g',
                 'h': 'h', 'i': 'i', 'j': 'j', 'k': 'k',
                 'l': 'l', 'm': 'm', 'n': 'n', 'o': 'o',
                 'p': 'p', 'q': 'q', 'r': 'r', 's': 's',
                 't': 't', 'u': 'u', 'v': 'v', 'w': 'w',
                 'x': 'x', 'y': 'y', 'z': 'z'}

if (len(sys.argv) < 2):
        print 'Укажите адрес, который необходимо закодировать'
        sys.exit(0)

email = sys.argv[1]
code = ''

for i in xrange(0, len(email)):
        code += chars[email[i]]

print 'Строка "' + email + '" в закодированном виде выглядит так:', \
      '\n\n', code, '\n'

либо ручным переводом символов.

Для небольшого описания надо использовать курсив:

Описание. Здесь добавляется описание документа

2.2.2. Содержание

Рассмотрим небольшой пример:

Содержание:
1. Глобальный раздел номер один

1.1. Подраздел 1.1

1.2. Кстати, вложенность подразделов может быть многократной

2. Глобальный раздел под номером два

2.1. Аналогично

2.2. Подраздел 2.2

2.3. Подраздел 2.3

Здесь samle - это имя страницы на сервере - оно должно быть уникальным.

2.2.3. Составление самого документа

Нами уже было определено несколько заделов. Создадим теперь заголовок для раздела 1

1. Глобальный раздел номер один

Загловки первого уровня вложенности оформляются тегами

, остальные -

3.1. Немного цензуры
Немного цензуры Крайне не приветствуется брань и вульгарные выражения (критерии определяют модераторы)