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

Материал из GIS-Lab
Перейти к навигации Перейти к поиску
Строка 41: Строка 41:
Основные используемые стили:
Основные используемые стили:


<span style="font-size:200%">Заголовок статьи</span>
<code><nowiki>==Название главы==</nowiki></code>
 
<code><nowiki>===Название подглавы===</nowiki></code>
<span style="font-size:155%; font-weight:bold">1. Название главы</span>
 
<span style="font-size:135%; font-weight:bold">1.1 Название подглавы</span>


==Аннотации==
==Аннотации==

Версия от 14:12, 23 марта 2012

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

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

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

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

Тема статьи

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

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

Также возможны комбинации любых вышеперечисленных типов статей.

Создание и редактирование статьи

Статьи на GIS-Lab создаются в вики. Однако, попадают в основной список статей они только после утверждения редактором.

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

Используйте {{Статья|Черновик}} в самом начале текста для обозначения черновиков статей.

Заголовок статьи должен быть на русском и отражать содержание статьи.

Шаблон

Специального шаблона для создания статьи пока нет.

В качестве примеров рекомендуем использовать другие статьи из списка опубликованных.

Текст

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

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

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

Аннотации

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

Пример кода: {{Аннотация|Использование выражений на языке Python для операций с полями в QGIS}}

Иллюстрации

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

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

название статьи + (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>

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

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

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