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

Материал из GIS-Lab
Перейти к: навигация, поиск
Эта страница опубликована на сайте в разделе «Организационные материалы»
по адресу http://gis-lab.info/qa/authors.html

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

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

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

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

Содержание

Тема статьи

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

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

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

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

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

Перед созданием документа, необходимо зайти в вики под своей учетной записью, используя имя пользователя и пароль с форума. Если у вас их еще нет - сначала зарегистрируйтесь. Иначе, при попытке редактирования или создания страницы будет выдаваться сообщение что редактировать/создавать страницы могут только участники из группы «Участники».

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

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

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

Черновик

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

Шаблон

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

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

Название

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

Если необходимо использовать кавычки, то должны быть использованы т.н. «ёлочки» (Alt+0171 и Alt+0187), другие кавычки использоваться не должны.

Текст

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

==Название главы==

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

Не используйте заголовки других уровней.

Для списков:

* - первый уровень элемента ненумерованного списка
** - второй уровень элемента ненумерованного списка

Код

Если в статье приводится программный код, то его можно добавлять двумя способами. Если кода мало (1-2) строки, то можно использовать теги <pre></pre> , например:

<pre>http://wfsserver?key1=value1&ke2=value2</pre>

Что будет выглядеть так:

http://wfsserver?key1=value1&ke2=value2

Если кода значительное количество, то можно использовать специальные теги, которые позволяют внести цветовую разметку. Например:

<syntaxhighlight lang="python">
table =  { 
'library' : 1000,
'other' : 2000,
'school' : 3000
}</syntaxhighlight>

Что будет выглядеть так:

table =  { 
'library' : 1000,
'other' : 2000,
'school' : 3000
}

Аннотации

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

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

Иллюстрации

Статьи должны иллюстрироваться. Для загрузки изображений служит специальная страница.

Имя файла иллюстрации не должно быть слишком общим, about, settings и т.д. Иначе существует риск, что следующий загруженный файл с таким названием перепишет ваш. Задавайте более уникальные имена, включающие название статьи, например: map-classification-grass-01.jpg.

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

Размер загружаемых иллюстраций не ограничен. Иллюстрации в статье должны быть ограничены 750 пикселями по ширине. Если ваша иллюстрация меньше чем 750 пикселей по ширине - не уменьшайте ее для вставки в статью, это позволит сэкономить на лишнем щелчке и открытии иллюстрации отдельно. Если ваша иллюстрация больше чем 750 пикселей по ширине, можно уменьшить ее, указав меньшую размерность, например так: [[Файл:Рис.JPG|мини|центр|300|Рис. 1. Структура папки]]

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

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

Чтобы сделать иллюстрацию со ссылкой, сделайте так (пример):

[[Файл:Nextgis.png|link=http://nextgis.ru]]

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

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

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

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

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

Публикация, шаг 1: После того, как вы сочли, что статья завершена, нужно создать тему на форуме, где дать ссылку на статью в вики и пригласить участников к её обсуждению. Следует быть готовым к критике и редактированию статьи в соответствие с замечаниями.

Публикация в основном списке

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

Ваша статья попадет в основной список статей после того, как она будет ими утверждена. Посмотреть, кто принимает решение публиковать или нет статью, обратиться и задать связанные с этим вопросы можно здесь.

Публикация, шаг 3: Зайдите в блог GIS-Lab по адресу: http://blog.gis-lab.info/wp-admin/ с созданной для вас учетной записью и создайте тему объявление о том, что появилась новая статья. Дайте ссылку на статью (не на вики!) и обсуждение ее в форуме.

Публикация, шаг 4: Зайдите в вики-страницу статьи и измените в начале статьи текст {{Статья|Черновик}} на {{Статья|Опубликована|article}}, где article - название файла статьи на сайте (не вики), без ".html"

Персональные инструменты
Пространства имён

Варианты
Действия
Статьи
Спецпроекты
Инструменты