Вебмастерам
Команда вебмастеров разрабатывает и поддерживает сайты ЕФСПО, начиная с fsfe.org и заканчивая сайтами проектов и кампаний. Вебмастера – это добровольцы, которые улучшают внешний вид организации и совершенствуют техническую составляющую деятельности Фонда в Интернете.
Технологии и программы, которые используются в работе веб-страниц ЕФСПО, хорошо знакомы многим разработчикам и могут представлять интерес для тех, кто ещё только начинает знакомство с ними.
Переводчики и другие добровольцы в своей работе, скорее всего, затронут лишь:
Те же, кто хочет помочь с поддержкой веб-сайтов, должны также знать
Страницы сайта fsfe.org хранятся в виде набора XML файлов, из которых каждые десять минут веб-сервер автоматически создаёт HTML страницы. Таким образом, редактируются только XML файлы, а HTML страницы никогда напрямую не затрагиваются.
Название каждой страницы на fsfe.org состоит из названиестраницы.язык.html, где язык соответствует одному из сокращений названий языков по стандарту ISO-639, например, «en» – английский, «de» – немецкий. Названия исходных файлов состоят из названиестраницы.язык.xhtml.
На некоторых страницах, помимо фиксированного текста из XHTML файла, есть динамические вставки. Это значит, что при их создании веб-сервер берёт текст из нескольких XML файлов. Если в одном из этих файлов текст не переведён, то будет вставлен фрагмент оригинальной страницы на английском языке. Именно так на сайте возникают страницы с текстом на двух языках. Примеры страниц с динамическими вставками: домашняя страница, страница новостей и страница событий.
Исходные файлы веб-страниц хранятся в репозитории, размещённом на сервере ЕФСПО. Просмотреть содержимое репозитория можно через систему Trac.
Получить доступ к этим инструментам можно следующим образом:
Если вы член Содружества ЕФСПО у вас уже есть доступ для чтения, нужно лишь ввести логин и пароль.
Если вы хотите получить доступ для записи (к репозиторию или к вики системы Trac), напишите об этом по адресу system-hackers@fsfeurope.org.
Если вы не являетесь членом Содружества, вы можете зарегистрироваться в качестве гостя. Таким образом вы получите доступ для чтения репозитория и в системе Trac (при вводе логина добавьте префикс guest-). Администратор репозитория получит автоматическое уведомление и активирует доступ для записи.
В репозитории Subversion хранятся две базы данных для сайта ЕФСПО: SVN trunk для главной версии сайта http://fsfe.org/ и test branch для тестовой версии сайта http://test.fsfe.org/.
Для повседневной работы, например, добавления новостей и новых переводов (или даже для внесения небольших изменений в код веб-сайта), нужно извлекать SVN trunk:
svn --username ВАШЕИМЯ co https://svn.fsfe.org/fsfe-web/trunk
Большие изменения в коде сайта, включая отладку новых функций, которые могут нарушить его нормальную работу лучше предварительно испытывать на тестовой версии репозитория test branch:
svn --username ВАШЕИМЯ co https://svn.fsfe.org/fsfe-web/branches/test
Обратите внимание – чтобы извлечь весь репозиторий потребуется около 160 Мб дискового пространства. Если вы хотите работать над определённой частью сайта, можно извлечь только её. Просмотреть содержимое репозитория и выбрать файлы для копирования можно через систему Trac.
После того, как нужные файлы извлечены, необходимо выполнять обновление
$ svn update
каждый раз перед тем, как приступить к работе.
Если вы хотите добавить в репозиторий новые файлы или каталоги, нужно выполнить
$ svn add название файла
Для того чтобы добавить файлы на сервер, будь то новый или изменённый файл, выполните
$ svn commit название файла
Откроется редактор, который у вас установлен по умолчанию, чтобы добавить примечание.
В системе Subversion должна быть включена замена ключевых слов. Поскольку некоторые ключевые слова используются в файлах .xml и .xhtml (например, $Author$ – ключевое слово в нижним колонтитуле страницы), вы настроить автоматическую замену ключевых слов, добавив следующий текст в файл ~/.subversion/config:
enable-auto-props = yes [auto-props] *.xml = svn:keywords=Date Author Id Revision;svn:mime-type=text/xml;svn:eol-style=native *.xhtml = svn:keywords=Date Author Id Revision;svn:mime-type=text/xhtml;svn:eol-style=native
Если вы знакомы с программой CVS, вы легко разберётесь с SVN, так как основные команды совпадают. О различиях между CVS и SVN можно почитать на странице Subversion для пользователей CVS, а сравнение команд CVS и SVN представлено в Руководстве по переходу с CVS на SVN.
Загрузить подробное руководство по SVN можно на странице Subversion book (ЕФСПО использует SVN версии 1.5).
Работа над страницами веб-сайта координируется через список рассылки для веб-мастеров.
Система Trac также предоставляет ряд инструментов для координации работ: браузер репозитория SVN, систему управления версиями и вики.
Более подробная информация о системе Trac опубликована в виде Руководства на странице вики.
Если вы хотите получать информацию обо всех изменениях в репозитории, подпишитесь на список рассылки уведомлений об изменениях.
Если у вас есть доступ для записи, подпишитесь на список рассылки для веб-мастеров.
Обратите внимание – все изменения, которые вы внесёте, станут видны автоматически. Поэтому просим вас при каждой загрузке новых или обновлённых файлов в репозиторий помнить, что:
ЕФСПО несёт ответственность за содержание веб-страниц. Не публикуйте изменения, которые могут исказить значение текста, без одобрения членов ассоциации ЕФСПО. (Актуально только для оригинальных страниц на английском языке.)
Если вы помогаете ЕФСПО с переводом, старайтесь всегда отдавать текст на проверку при наличии такой возможности. Подпишитесь на список рассылки для переводчиков, чтобы узнать, может ли кто-нибудь помочь вам. Желательно также всегда пользоваться автоматическими средствами проверки орфографии, например, GNU aspell, ispell или любыми другими. Установите файл aspell и aspell-XX (где "XX" – двухбуквенный код языка) и выполните:
aspell -H -d language -c file.xhtml
где «language» – название словаря языка; -d – можно опустить, если региональный код системы UNIX совпадет с языком словаря.
Убедитесь, что все файлы в правильном формате XML. По умолчанию сервер SVN проверит синтаксис XML файлов с разрешением .xml и .xhtml extensions и отменит загрузку, если обнаружит ошибки. Также файлы можно самостоятельно проверить перед загрузкой одним из способов, перечисленных ниже.
С помощью сценария /trunk/tools/validate.pl. Он найдёт ошибки в разметке, которые могут вывести из строя автоматическое обновление страниц на сайте ЕФСПО. Если у вас сложилось впечатление, что процесс создания страниц нарушен, посмотрите журнал событий последней рабочей версии на странице состояния веб-сервера.
Для сценария validate.pl нужен модуль Perl XML::LibXML. Если он не установлен, можно проверить файлы через любую другую программу проверки правильности разметки XML. Например, можно использовать программу xmllint с доступом из командной строки, разработанную в рамках проекта libxml2.
Если вы используете операционную систему Debian GNU/Linux, установите программу libxml2-utils и выполните команду:
xmllint --noout file.xhtml
где file – название файла, который вы хотите проверить. Если программа обнаружит ошибку, появится соответствующее сообщение.
Убедитесь, что кодировка файла совпадает с названием кодировки в его верхней части (там, где слово «encoding»). Например, если файл сохранён в кодировке «iso-8859-1» (latin-1), то в первой строке должно быть написано:
<?xml version="1.0" encoding="iso-8859-1" ?>
Другая допустимая кодировка – «UTF-8». Изменить кодировку файла можно с помощью стандартной программы iconv следующим образом (пример конвертации файла из «latin1» в «UTF-8»):
iconv -f LATIN1 -t UTF8 inputfile > outputfile
При добавлении файлов в репозиторий обязательно координируйте свои действия с другими добровольцами, у которых тоже есть доступ для записи, чтобы добавления новых и обновлённых файлов были правильными. И, конечно же, проверяйте файлы перед тем, как загрузить их в репозиторий.
Структура fsfe.org довольно сложна и скрыта от глаз простого пользователя из-за того, что на сайте есть страницы как для аудитории в масштабах всей Европы и мира, так и страницы с информацией для конкретных стран.
Если вы хотите не только переводить страницы, но и помогать на других направлениях, ознакомьтесь со структурой сайта.
Или скачайте файл руководства «Вебмастерам ЕФСПО» в формате Texinfo, который написал Йонас Оберг. Он также внедрил систему компиляции HTML страниц из XML файлов. В руководстве подробно разобран механизм работы веб-страниц.