Reformy GK: Mat-Teh

Реформы Гусарского Клуба: Мат-Тех

Здесь описываются цели, задачи, методы их достижения и план работы Мат-Тех комиссии.

Прежде всего, формулируем самые-пресамые конечные цели - т.е. характеристики нового клубного сайта и проблемы его поддержки.
1. Сайт должен быть приятно оформлен. Дизайн должен быть грамотно продуман и присутствовать на всех страницах. Дизайн должен предусматривать использование рекламных баннеров.
2. Дизайн должен быть лёгким, чтобы его нетрудно было навесить на любую Клубную страницу. Чем главнее и реже тип страницы, тем тяжелее дизайн. Т.е. дизайн прихожей явно должен быть намного тяжелее дизайна конкурсной страницы. В связи с этим дизайн должен предполагать наличие нескольких компонент, которые используются в разном количестве на разных страницах.
3. Исключения могут представлять только динамические страницы, недоступные при обычном заходе, а являющиеся результатом подачи формы в "типично-гусарских" системах. Пример: чат, ответ канцелярии на подачу формы. Пример, когда ответ системы всё равно обязан иметь гусарский дизайн: ответ формы при подаче заявления в академию юнкеров. Конечно, в идеале нужно пытыться навесить дизайн на всё, что только возможно.
4. Страницы должны быть достаточно лёгкими, неплохо загружаемыми медленными модемами. Наша целевая аудитория - ВСЕ.
5. Дизайн должен грамотно смотреться во всех браузерах, включая текстовые (типа LYNX). Само собой, некоторые браузеры позволят отобразить больше, чем другие (т.е. графический браузер, например, лучше текстового), но сама текстовая начинка, навигация и "шапка" должны быть доступны всем. При решении вопросов переносимости мы должны ориентироваться примерно на третий HTML и третьи браузеры, т.к. несмотря на отход третьих нетскейпов и эксплореров из употребления другие браузеры сильно расходятся в интерпретации четвёртых наворотов, но таблицы рендерят правильно. Кроме того, мы не можем пользоваться образцами профессиональных сайтов, т.к. настоящие профессиональные сайты затачивают выводимый HTML под браузер клиента, который определяется в HTTP-запросе. У нас этих механизмов нет. Кроме того, мы хотим, чтобы любая простая программа-паук смогла пройтись по нашему сайту без потери навигации и информации.
6. Дизайн должен быть легко узнаваемым. Любая гусарская страница, найденная посетителем-чужаком через поисковую систему или по линку неведомо откуда, должна быть легко узнаваема, как гусарская. Навигация также должна касаться всех страниц, чтобы этот самый посетитель-чайник, заинтересовавшись, мог сделать логический "шаг назад", не разбираясь в правилах построения URL. Пример плохих страниц в этом контексте - тексты почтовых сообщений в новостях.
7. Сайт должен быть грамотно организован и пронизан системой навигации. Количество кликов для достижения любой страницы должно быть минимальным, и, грубо говоря, обратно пропорциональным важности страницы.
8. Дизайн, навигация, терминология и комментарии разделов должны быть расчитаны на гибрид опытного гусара и посетителя-чайника. Чайник всегда должен понимать, куда идёт, кликая на линки "вглубь", а гусар должен легко находить глазом нужные ему линки, если он знает, что ищет (не читая долгие комментарии). В связи с этим названия разделов должны строиться по функциональной сути разделов, а не по гусарской терминологии. Например, должны быть "конкурсы клуба", а не "творческая кухня". "Кладбище" вообще ни в какие ворота не лезет, особенно учитывая наличие довольно реального Мемориала.
9. Сайт должен быть читабельным - чтоб текст в кириллице использовался только там, где он может быть правильно отображаем всеми браузерами на всех операционках.
10. Сайт должен быть лёгок в поддержке. Прежде всего, должно быть легко добать "рутинную" страницу - новую конкурсную страницу, например.
11. Сайт должен быть переносимым - чтобы его было легко перенести на другой домен, типа припаркованного Грыжевским "www.gusary.com".
12. Сайт должен быть лёгок во внутренней модификации - смена статической страницы на динамическую и прочее должно менять минимум линков.
13. Линки должны быть не только корректными, но и логичными - т.е. быть или относительным путём (в случае линка на страницу в том же логическом разделе, что и ссылающая страница), или абсолютным путём (в случае линка на страницу в другом разделе).
14. Сайт не должен содержать лишние файлы и всякое барахло. Если без этого никак, то барахло должно быть легко и автоматически узнаваемо. Например, хорошо бы иметь директорию JUNK или что-то в этом духе.
15. Весь сайт должен быть автоматически проверяем - чтобы, скажем, раз в месяц можно было находить все направильные ссылки и лишние файлы. Для этого страницы должны быть правильно организованы и свёрстаны. Страницы должны поддаваться парсингу программой (или веб-пауком, или программой, анализирующей страницы сайта в оффлайне на куличках или после скачивания по FTP). Для этого все страницы должны быть заточены соответствующим образом.
16. Организация путей должна быть чёткой, русской, стандартной, в строчных буквах. Адреса типа "/Kadry" или "news.hml" недопустимы - должно быть "/kadry/" и "/novosti/".
17. Все материалы должны быть доступны к модификации нашим же администраторам - т.е. всё должно лежать на клубных аккаунтах, а не на личных. Это облегчит поддержку, увеличит надёжность, сделает возможным централизованную поддержку и backup. Уже зарегистрированы случаи потери очень важных материалов на личных аккаунтах, поэтому пунктом пренебрегать не стоит.
18. Сайт должен легко подвергаться редизайну. По крайней мере, должно быть легко сменить стандартные компоненты внешнего вида и навигации программой, у подавляющего большинства страниц, и у всех "изначально заброшенных" страниц, таких как рутинные страницы в цепочках или страницы почтовых сообщений в новостях.
19. Несмотря на изначальную заточку сайта под автоматические проверки и модификации, сайт должен быть построен таким образом, чтобы надёжность линков была очень высокой. Хорошим ходом некогда было создание страницы "дежурного" вместо указания прямого адреса Остен-Закена. Однако, мы должны в этом пойти ещё дальше - вообще не указывать никаких адресов, а вместо них вести одним линком на одну страницу, где этот адрес всегда был бы корректным. Например, вместо адреса электронной почты конкретного ведущего или зава, должен быть линк на соответствующую страницу человека в Отделе Кадров или страницу руководящего органа/должности в соответствующем разделе. Например, линк на "основателя и многолетнего ведущего конкурса Януса Невструева" должен вести на страницу Невструева в отделе кадров, где был бы доступен его последний адрес, а не на "mailto:slava@eng.tau.ac.il".
20. Сайт должен не содержать повторений. Старый принцип про один авторитетный источник любой информации должен строго соблюдаться. Например, каждый раздел не должен иметь свою копию логотипа Клуба. А если кто-то на что-то ссылается, то надёжность ссылки должна быть выше надёжности страницы. Например, этот принцип объясняет всю неправильность использования адресов электронной почты на страницы. Вместо того, чтобы логически говорить "вот адрес заведующего" (утверждение, которое вскорости становится неправильным), нужно говорить "вот линк на страницу заведующего, в которой хранится его адрес" или "вот линк на страницу Невструева, где описаны все способы с ним связаться". Это касается всего - адресов листов, адресов комиссий, привязки должностей к именам, и т.д.
21. В связи со всем вышесказанным, все страницы должны подчиняться аккуратно созданным правилам вёрстки. Эти правила должны быть точно и строго сформулированы таким образом, чтобы любую страницу можно было однозначно и автоматически проверить на соответствие каждому из них.
22. Сайт должен поддерживаться в обязательном порядке. Чаще всего поддержка сводится к напоминанию ответственным за конкурс убрать надпись "НОВЫЙ ТУР!!!" со страницы, когда сбор работ окончен, и добавить линк на страницу с работами в Архиве, когда голосование закрыто. Кроме того, нужно регулярно запускать программу-проверяльщицу, чтоб она находила неправильные линки и страницы, не удовлетворяющие нашим же правилам вёрстки.
Теперь формулируем высокоуровневые методы
1. Создать Гусарскую Инструкцию по Поддержке Сайта (ГИПС), и признать её её обязательной для всех страниц сайта.
2. Для поддержки ГИПСа ввести правило: не открывать никакие страницы до отмашки ответственных за поддержку ГИПСа (читай: Мат-Тех комиссии, в количестве одного одобрения).
3. Всем разделам сайта назначить ответственных за поддержку, с Мат-Техом по умолчанию в нерасхваченных гусарами разделах. Ответственный имеет право модификации соответствующих страниц, при условии обязательной готовности вносить необходимые коррективы.
4. Написать программу-парсер, которая ходила бы по директориям и файлам сайта и проверяла соответствие ГИПСу. При необходимости на базе этой программы можно создать другую программу, которая вносила бы в страницы автоматические изменения по мере надобности.
5. Написать программу-парсер, которая анализировала бы вёрстку одного файла на соответствие ГИПСу. Остановка разрешается после первой ошибки. Сделать программу публично доступной. Требовать её использования.
6. Регулярно запускать программу проверки сайта. В случае ошибок рапортовать ответственным, требовать исправлений, или отбирать права. Злостных нарушителей к ногтю! :-)

Конкретика

Одноразовые действия

Создать трафареты страниц, включающие в себя необходимые компоненты навигации, оформления и прочей фигни, не связанной с текстом страницы. Каждому трафарету дать имя.
Трафареты нашпиговать целевыми "блоками" - кусками HTML-кода, обеспечивающими необходимую функциональность. Каждому блоку дать имя, каждый трафарет определить как последовательность "стандартных" и пользовательских блоков. Начало и конец каждого блока помечать стандартным HTML-комментарием ( , или как-то так), чтобы эти блоки легко узнавались парсером.
Разбить материалы на подразделы согласно категориям, а не темам. Все документы (нынешние докУменты, положения, памятки, дуэльные кодексы, Факи, инструкции и указы) - вместе. Всё стихотворное и не очень творчество гусар, архивы, избранное - вместе (тонкость с канцелярией, но это мелочи). Все конкурсные страницы, старые и не очень - на одну страницу с оглавлением. Упразднить Чердак - всё равно его никто поддерживать не будет - а материалы разбросать по соответствующим разделам.

Проект контент разбивки:

Glavnaja
    Tvorchestvo (Arhivy)                         ->/arhiv/
        IZBRANNOE                                ->kan:/arhiv/izbrannoe/
        Konkursy                                 ->kan:/arhiv/konkursy/
        Turniry                                  ->kan:/arhiv/turniry/
        Dueli                                    ->kan:/arhiv/dueli/
        Tsepochki Lista "Gospoda Gusary" (KLP2)  ->/arhiv/tsepochki/
        Rashodjaschijsja Rzhevskij               ->ideal:/rzhev/arhiv/
        Prochee Literaturnoe nasledie (KLP)      ->/arhiv/poezija/
        Al'manah                                 ->/arhiv/almanah/
        Filosofii                                ->/arhiv/filosofii/
    Zabavy                                     ->/zabavy/
        Konkursy                               ->/zabavy/konkursy/
        Turniry                                ->/zabavy/turniry/
        Dueli                                  ->/zabavy/dueli/
        Rashodjaschijsja Rzhevskij             ->ideal:/rzhev/
        Gusarskaja Ruletka                     ->kan:/ruletka/
        COPTUP, CTEHA COPTUPA                  ->/zabavy/COPTUP/
        Kladbische                             ->/zabavy/kladbische/
        Bordel' madam Lopuhinoj                ->/zabavy/bordel/
    Hronika                                    ->/hronika/
        Golosovanija v Kantseljarii            ->kan:/
        Novosti                                ->kan:/novosti/
            [svezhee]                               #
            [svetskie hroniki]                      #
            [rukovodstvo]                           #
            ...
        Starye Novosti                        ->kan:/novosti/staroe/
            [svetskie hroniki]
            [rukovodstvo]
        Popojki na Poligone                   ->/hronika/popojki/
        Istorija Kluba                        ->/hronika/istorija/
        Prochie istoricheskie materialy       ->/hronika/raznoe/
    Interesy                                  ->/interesy/
        Gusarskij Istoricheskij Muzej         ->/interesy/gim/
        Gusarskoe tvorchestvo klassikov       ->/interesy/klassika/
        Ljubimye anekdoty GK                  ->/interesy/anekdoty/
        Ljubimye mesta GK v pautine           ->/interesy/mesta/
    Otdel Kadrov, Bjurokratija                ->/kadry/
        Akademija Junkerov (vstupit' v Klub?) ->/kadry/akademija/
        Spisok Gusarov, lichnye dos'e        ->kan:/kadry/vse/    ??
        Posluzhnye spiski                    ->kan:/kadry/spiski/ ??
        Aktiv Kluba, nachal'stvo             ->kan:/kadry/aktiv/
        Stranitsa Shtaba                     ->kan:/kadry/shtab/
        Stranitsa TK                         ->kan:/kadry/tk/
        Stranitsa Mat-Teha                   ->kan:/kadry/matteh/
        Simvolika                            ->/kan/simvoly/ ??
        ...
    Krome Shutok!                            -> /serjozno/
        Gusarskij Memorial                   -> /serjozno/memorial/
    Dokumenty                                -> kan:/dokumenty/
           --- dlja teh, kto zdes' vpervye ---  #
        Pamjatka dlja vstupajuschih v Klub
           --- nachal'stvo, bjurokratija ---
        Polozhenie o Rukoj Vodjaschih Organah
        Polozhenie o minimal'noj aktivnosti ---
           --- tvorcheskaja zhizn' ---
        Polozhenie o Kruzhkah i Konkursah
           --- pochta ---
        E-mail kodeks
           --- dueli ---
        Pamjatka dlja dueljantov
           --- kantseljarskie pamjatki ---
        Pamjatka veduschim konkursov
        Pamjatka sekundantam
        ...

Дизайн
1. Главные друзья дизайна - простота и педантичная аккуратность, единый мотив. Спокойствие.
2. Главные враги дизайна - аляповатость, напичкивание разномастных картинок, крикливость, претензии на уникальность.
3. Главная хитрость дизайна - времена сменились, и Клуб должен привлекать не столько оригинальностью и гусаристостью, сколько качеством материала (который у нас есть!) - и потому должен не выпендриваться, а делать очень удобным доступ, поиск и ознакомление.
4. Классифицировать документы то "типам". Каждому типа разработать трафарет. Трафареты составлять из независимых блоков. Трафареты наследовать друг из друга.
5. ВСЕ страницы должны быть узнаваемы, т.е. все трафареты должны иметь что-то общее. Ясно, что напрашивается шапка (скажем, для логотипов, баннеров, линков на главную страницу Клуба) и валенки (для копирайта, линка на дежурного, и т.д.). Может, конечно, и без баннеров - т.к. в зависимости от раскладки страницы баннер может лучше воткнуться в другие места. Страниц в Клубе много, и так или иначе они могут оказаться разномастными. Минимальный трафарет, таким образом, должен нормально смотреться со всеми страницами, со всеми их дизайнами, палитрами и заморочками. Гоняться за очень стильным трафаретом не представляется возможным - рано или поздно он начнёт мешать. Поэтому, может, сразу сделать его выделяющимся - типа, чёрная полоса шириной в экан и высотой в одну строку, а под ней - что угодно. На строке - линк на Гусарский Клуб, линк на страницу смены кодировки, и прочее. Из такого трафарета легко сделать несколько более тяжёлых трафаретов - горизонтальных полос становится больше, и в них указываются название страницы и её положение в дереве (Типа, "Клуб::Конкурсы::Лимерики::Тур 11"). Дальше - по вкусу.
6. Часто повторяющееся содержание главных страниц - по сути, меню разделов (главный вход, конкурсы, т.д.). Исходя из требований удобства для опытных гусаров и понятности для новичков, подход такой. Линк на большой раздел по названию, небольшой перечень самых важных подпунктов (если они не одинаковые по важности), а затем текст в два-три предложения шрифтом "минус один", объясняющий суть раздела. Например: крупно, линк - "Отдел Кадров"; нормально, линки - "Списки Гусаров, Клубное начальство, Академия Юнкеров, вступление в Клуб"; текст - "Хотите познакомиться с нами поближе? Узнать, кто есть ху? Связаться с ответственными или куда-нибудь вступить? Вам сюда!". Тексты продумать, поручить стилисту. Комментировать только шаги вперёд, а путь назад делать красивым, доступным, но без лишнего трёпа. Шаги вбок аккуратно продумывать и, если что, везде создавать ощущение закладок, чтоб было понятно, что произойдёт при переходе и, таким образом, какое взаимоотношение страниц.
7. Функционально одинаковые части разных страниц должны выглядеть одинаково. Навигация "назад" должна быть одинаковой. Блоки "смотри также" с линками на близки по смыслу разделы, а также комментирующие блоки а-ля "пояснение заполняющему форму" должны выглядеть, как две капли водки.
8. Главная страница - самая главная и самая страница. Линков должно быть много, и все умные, и все понятные.
9. Ни в коем случае не использовать длиннющих текстов, привязанных за уши к нужным линкам, с миллионом линков по ходу дела. Всё равно длинные тексты никто не читает, а вставить в него новый линк сложно. Всё должно быть коротко, чётко, ясно, чтоб проглядывающий страницу по диагонали серфер не убегал.
10. ВЕЗДЕ ОБРАТНАЯ НАВИГАЦИЯ! И не просто "обратно, туда, обратно, сюда", а чтоб было видно, частью чего является текущий раздел. Типа, не "В кружок Гаврилиадчиков", а "Гусарский Клуб - Литературные Конкурсы - Гаврилиады - ((Пятый Тур))
11. Линки - это линки. Все подчёркиваем, не выпендриваемся.
12. Все страницы должны нормально укладываться в окно браузера при разрешении 800x600, при условии использования стандартных (маленьких) шрифтов.
13. В целом, дизайн должен быть плавающим - подстраивающимся под ширину окна браузера, а не фиксированной ширины.
Проект ГИПСа
1. Общая организация сервера
  1. Весь гусарский сайт находится на Чёртовых Куличках, под аккаунтами "gusary" и "kruzhki". Канцелярские системы лежат на сервере "leolan.com".
  2. Аккаунт "gusary" содержит общие страницы, оглавления, и тому подобные "главные" страницы, которые редко меняются. Поддерживаются эти страницы Мат-Техом. Доступ имеют Мат-Тех, Штаб и, если нужно, ТК.
  3. Аккаунт "kruzhki" содержит основную часть материалов на Куличках. Доступ возможен всем ответственным за какие-либо страницы.
  4. С веба доступ к аккаунту "kruzhki" полностью закрыт. Доступ к аккаунту "gusary" доступен только с домена "gusary.kulichki.com" (www.kulichki.com/gusary/ нужно закрыть или обеспечить автоматический редирект).Это обеспечит переносимость сайта на другой сервер, т.к. все адреса будут строиться с корневого уровня внутри домена. Единственный возможный домен обеспечит правильность навигации - т.к. одна и та же навигация обычно не работает для этих двух вариантов, а поисковые системы могут найти любой из них. Один стандартный вариант значительно упростит жизнь и корректность найденных страниц.
  5. Для корректного доступа с веба на аккаунте "gusary" будут находится символические линки (symlinks) на директории в кружках, так что с веба разница будет незаметна.
  6. Кроме описанных выше, никаких симлинков, чтоб не запутывать администраторов.
  7. Все неиспользуемые материалы кладутся в подкаталог junk раздела, которому они принадлежат. Найденные автоматом неиспользуемые материалы в других местах выбрасываются нахрен! Ответственные, постоянно хранящие неиспользуемые материалы в каталогах junk, и ничего с ними не делающие, будут получать по кумполу! :-)
  8. Сервер "leolan.com" поддерживается Стрельцом, с регулярным копированием информации на другой сервер.
2. Директории, файлы, связки, интернет-адреса
  1. Имена всех директорий и файлов состоят только из строчных английских букв, цифр, знаков тире и подчёркивания (не более одного подряд, и только между буквами или цифрами), точек в произвольном количестве, и расширений по смыслу. Начинаются все имена только на буквы. Представляют собой транслитерированные русские слова, за исключением index-файлов. Большинство имён выбираются по русскому слову, по возможности короткому.Это даст всем адресам читабельный вид, типа /konkursy/rubai/tur4/ или /anekdoty/rzhevskij/denschik/. Адреса станут запоминающимися и интуитивными.
  2. Большинство html-файлов лежат в специально выделенных каталогах и называются "index.html". Это позволит адресам не показывать некошерные на русском языке части адресов, а также сделает возможным следующий пункт.
  3. Все линки на страницы заканчиваются слэшем, и указывают на директорию, в которой лежит соответствующий index-файл.Это сделает все линки короче, читабельнее, красивее для русского посетителя и не-технаря; позволит впоследствии изменить статический html-файл на другой, вроде скрипта CGI, без единого исправления линков на данную страницу. Использование одного канонического адреса для каждого файла также упростит работу проверяльщика-паука, который не будет принимать одну страницу за две.
  4. Все перекрёстные линки между страницами одного логического раздела делать относительными, типа "./tur2/" или "./../vne_konkursa/". Все линки между страницами разных разделов делать абсолютными, типа "/novosti/". Не допускать имени сервера ни в каких линках внутри сайта. Это обеспечит надёжность линков при переносе страниц, а также целостность при переезде на другой сервер или домен.
  5. Все графические файлы, используемые страницами, положить в одну директорию (и, может, её поддиректории). Доступ к ним везде делать при помощи абсолютного пути к файлу, типа "/graf/main_logo.gif". Исключения разрешаются только при согласии мат-теха в особенных случаях (таких, как Полигон). Сведёт используемые размеры к минимуму, позволит оптимизировать все картинки одним махом, даст всем клубным разработчикам единый список всего имеющегося барахла, позволит программе легко найти заброшенные и неиспользуемые файлы.
  6. Все не-графические и не-html файлы (типа midi-музыки и прибабахов) положить в одну директорию (и, может, её поддиректории). Доступ к ним везде делать при помощи абсолютного пути к файлу, типа "/raznoe/chopin.mid". Исключения разрешаются только при согласии мат-теха в особенных случаях (таких, как Полигон). На пару с предыдущим пунктом, сделает все директории чистыми.
  7. Директории /graf/ и /raznoe/ разместить на аккаунте "kruzhki" (чтобы все могли добавить туда необходимые файлы), с симлинками из аккаунта "gusary" (чтобы доступ с веба был по абсолютным путям).
3. Вёрстка
  1. Запрещается использование (без особого разрешения маттеха):
    1. Фреймов, Яваскрипта, CSS, Cookies, любых скриптовых примочек, интерпретируемых браузерами, HTML-4, DHTML, HTML-тэгов или аттрибутов, по-разному поддерживаемых (или вообще не поддерживаемых) третьими версиями IE и NN, прочей фигни. Что не разрешено, то нельзя!
    2. Использование вёрстки не по трафаретам. Если нет подходящего трафарета - обращайтесь в МатТех с рацпредложением.
    3. Модификация стандартных блоков трафаретов или разделительные комментарии, а также использование разделительных комментариев не к месту.
    4. Шрифтов с указанием гарнитуры (или как оно там, по-научному), а также шрифтов размером мельче, чем -1.
    5. Наклонных шрифтов размером -1
    6. Кириллицы в атрибутах тэгов IMG, INPUT (TYPE=SUBMIT), а также в тексте, охваченном блоковыми тэгами TITLE, OPTION.
    7. Транслита в основном тексте документа, если возможно написание в кириллице.
  2. Разрешается использование:
    1. Тэгов и их атрибутов: HTML, HEAD, TITLE, BODY(...), HR(NOSHADE), BR, P(ALIGN), FONT(SIZE,COLOR), H1, H2, H3, H4, H5, PRE, TT, BLOCKQUOTE, NOBR, UL, OL, LI, A(HREF, NAME), IMG, TABLE(WIDTH, BGCOLOR, BACKGROUND, ALIGN, CELLPADDING, CELLSPACING, BORDER), TR(VALIGN, BGCOLOR, BACKGROUND ), TD(COLSPAN, ROWSPAN, WIDTH, ALIGN, VALIGN, BGCOLOR, BACKGROUND), FORM(METHOD, ACTION), INPUT(...), TEXTAREA(...) ... что забыл?.
    2. Кириллицы в теле документа, а также в тэгах INPUT (TYPE=TEXT) и TEXTAREA.
  3. Тонкости
    1. Ни на одной странице не указывается адрес электронной почты гусара, должностного лица или рво. Вместо этого делаются линки на соответствующие страницы в канцелярии.
    2. Ни на одной странице не указываются линки на разные кодировки. Вместо этого делается один линк "HE BUDEH TEKCT?", или как-то так, на страницу в канцелярии - канцелярия дальше со всем разберётся.