Технические рекомендации к статьям, публикуемым на GIS-Lab

Материал из GIS-Lab
Версия от 08:32, 20 марта 2012; Bishop (обсуждение | вклад) (Перенос с http://gis-lab.info/qa/authors.html)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)
Перейти к навигации Перейти к поиску
Эта страница является черновиком статьи.


Если Вы решили написать и/или опубликовать свою статью, заметку, описание и разместить ее на GIS-Lab, рекомендуем ознакомиться с этими рекомендациями.

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

Если у Вас пока нет прав для редактирования файлов на сервере GIS-Lab, вы можете прислать статью и дополнительный файлы на наш адрес и мы разместим их в нужном порядке. В дальнейшем, Вы можете получить права для редактирования статей и операций с файлами прямо на сервере.

Данные технические требования необходимы для более оперативного появления материалов на сайте GIS-Lab. Если вы не согласны с какими-либо из перечисленных критериев или имеете что добавить, пожалуйста, пишите на электронную почту, а также в обсуждение этих рекомендаций на форуме.

Шаблон

Для редактирования статей лучше использовать следующий шаблон. Сохранение одной из страниц GIS-Lab с помощью веб-браузера и ее редактирование недопустимо, так как сайт использует специальные шаблоны обрабатываемые сервером и исходное содержание страниц не одно и тоже что сохраняется веб-браузером.

Скачать шаблон

Если вы воспользовались шаблоном - пришлите нам обратно содержимое папки qa (статья) и images (изображения), остальное присылать необязательно.

Тема статьи

Тема статьи должна соответствовать тематике сайта, так или иначе касаться пространственных технологий. Используемое программное обеспечение большого значения не имеет. Результаты полученные в статье должны быть как можно более четкими и воспроизводимыми. Статья может быть следующего типа:

Статья-инструкция - как решить ту или иную задачу в том или ином программном обеспечении ГИС (например: Импорт данных в формате HDF) Статья-идея, четко изложенная, возможно без технической реализации Статья-описание проекта - описание проекта с техническими подробностями, которые могут помочь сэкономить время специалистам сталкивающимся с подобными задачами (например: Выделение местообитаний гаршнепа с помощью ДЗЗ) Статья-FAQ - набор вопросов и ответов по определенной теме (например: FAQ по проекциям) Статья-описание программного продукта краткое и более полное. Продукт может быть как свободнораспространяемый, так и коммерческий. Статья не должна носить явный рекламный характер, но давать четкую информацию о программном продукте без необоснованных эмоциональных комментариев (например: Описание программного продукта Google-Earth). Статья-данные - описание набора данных: бумажной карты, электронной карты, набора слоев, геобазыданных и т.д. (например: Описание данных VMap0) Статья-перевод - перевод другой статьи, при наличие соответствующего разрешения авторов изначального материала (например: Интерпретация данных Landsat TM / ETM+) Комбинация любых вышеперечисленных типов статей, а также другие типы статей Заголовок статьи, кроме как собственно в тексте статьи, дается также в начале HTML кода, в тэге title. Например:

 <title>GIS-Lab: Требования к статья публикующимся на GIS-Lab</title>

Название файла статьи должно быть по возможности коротким и значимым, т.е. отражать насколько это возможно содержание. В названии статьи не должно содержаться пробелов и специальных символов.

Хорошее название файла Плохое название файла
atcor.html arcview.html
biangulation.html gis.html
hdfimport.html myarticle.html

Текст

Для текста статьи необходимо использовать набор стилей, единых для всего сайта. Получить список стилей.

Основные используемые стили:

Заголовок статьи

1. Название главы

1.1 Название подглавы

Аннотация к статье


Текст статьи

программный код или вводимые команды командной строки

Иллюстрации

Название файла

Название файлов иллюстраций должно соответствовать схеме:

название статьи + (0)i.расширение Например: addprjag-01.gif, addprjag-02.gif, addprjag-03.jpg

где i - порядковый номер иллюстрации (если меньше 10, то перед номером добавляется 0), расширение - расширение соответствующее типу изображения (см. 4.2 Формат).

Формат

Для полноцветных изображений рекомендуется использовать формат JPEG, со степенью сжатия не менее 50, для индексированных изображений - GIF.

Местоположение

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

/images/figure-01.gif

Размер

Размер иллюстраций не должен превышать 500 пикселей по горизонтали и 300 пикселей по вертикали и должен быть ограничен одной из этих осей.

Если вы используете копию экрана, старайтесь не уменьшать ее в графическом редакторе, если это все-таки необходимо, не уменьшайте ее более чем на 25% (т.е. она должна быть не меньше 75% оригинала).

Также для больших иллюстрации можно использовать специальный скрипт, назначаемый уменьшенной копии изображения. При использовании такого подхода на странице помещается уменьшенная копия изображения, ей назначается специальный скрипт, который при нажатии на уменьшенную версию открывает изображение нормального размера (т.н. всплывающее или popup-изображение). Название файла большой иллюстрации должно быть равно названию уменьшенной копии + b, например figure-01.gif и figure-01b.gif. Пример кода:

<a href="/images/garshnep-12.jpg" onClick="NewWindow(this.href,'mm','650','550','yes');return false;">
<IMG height=234 alt="Щелкните для получения увеличенного изображения" src="/images/garshnep-12b.jpg" width=300 border=0></a>

Пример того, как работает такая форма представления увеличенных изображений (посмотреть).

Акцентирование определенных участков иллюстраций

Для того, чтобы подчеркнуть некоторую область на изображений можно выделить ее тонкой красной линией, для этого в Photoshop, необходимо загрузить изображение, выделить нужный регион с помощью инструменты выделения, выбрать из меню - Select\Modify\Border, размер 2 pix, далее Edit\Fill красным или другим цветом.

Ссылки на дополнительные материалы и прилагаемые файлы

Ссылки на дополнительные материалы, в том числе другие разделы GIS-Lab, могут даваться как в тексте, так и в блоке "См.также", располагающегося внизу страницы. Блок "см.также" должен содержать только основные ссылки.

Дополнительные файлы, ссылки на которые вы хотите дать в статье, необходимо поместить в папку /other и дать на них соответствующую ссылку.

Обсуждение в форуме

Каждой статье, описанию проекта и другим материалам, имеющим свою страницу на сайте должно соответствовать обсуждение на форуме GIS-Lab в разделе "Материалы сайта". Для того, чтобы вставить ссылку на обсуждение в статью, необходимо:

а) Создать в форуме в разделе "Материалы сайта" соответствующую тему-обсуждение. Текст темы должен включать название статьи и интернет-ссылку на саму статью.

б) Получить номер темы на форуме. Для этого необходимо перейти к списку тем в форуме в разделе "Материалы сайта" и скопировать ссылку на обсуждение темы, она имеет вид:

http://gis-lab.info/forum/viewtopic.php?t=875

где - 875 - номер темы необходимый, для подключения ее к статьи и автоматическому отслеживанию количество постов в теме.

в) Вставить специальные код в html-код статьи, причем NNN необходимо заменить на код, полученный в предыдущем шаге.

<p align="center" class="text">
<!--#include virtual="/scripts/forum-comments-num.php?i=NNN"-->
</p>

7. Последнее обновление

Каждая страница должна заканчиваться датой последнего ее обновления. Для того, чтобы эта дата автоматически обновлялась, необходимо подключить следующий скрипт:

<!--#include virtual="/scripts/date.php" -->
Спасибо за участие в нашем проекте, надеемся он станет и Вашим!