Справка:Описания клиентов: различия между версиями

Материал из Мир Jabber
Перейти к навигацииПерейти к поиску
м
м (Для минимизации можно убрать. Пихать все клиенты на страницу клиентов - неактуально. Используйте категории)
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
Если Вы хотите сделать описание для [[Клиенты Jabber|Jabber-клиента]], который отсутствует на [[Клиенты Jabber|странице-списке клиентов]], то Вам пригодятся следующие указания:
Если Вы хотите сделать описание для [[Клиенты Jabber|Jabber-клиента]], который отсутствует на вики, то Вам пригодятся следующие указания:


* Ссылка на клиент должна быть со [[Клиенты Jabber|страницы клиентов]] (если иное не оговорено на странице обсуждения клиентов, например, для Windows-клиентов уже просто нет места)
* Ссылка должна являться корректным именем клиента
* Ссылка должна являться корректным именем клиента
* Описание состоит из нескольких предложений, описывающих особенности данного клиента. Обычно неплохо Jabber-клиенты описываются на [[ru_wikipedia:|Wikipedia]], поэтому на вступление можно ориентироваться там. Для уменьшения необходимости постоянного обслуживания страниц можно не описывать фичи клиентов, так как они постоянно меняются и хорошо описаны, к примеру, на [[ru_wikipedia:|Wikipedia]]. Справа делается скриншот. Внизу делается раздел "Ссылки" со следующими ссылками:
* Описание состоит из нескольких предложений, описывающих особенности данного клиента. Обычно неплохо Jabber-клиенты описываются на [[ru_wikipedia:|Wikipedia]], поэтому на вступление можно ориентироваться там. Для уменьшения необходимости постоянного обслуживания страниц можно не описывать подробно все новейшие фичи клиентов, так как они постоянно меняются и хорошо описаны, к примеру, на [[ru_wikipedia:|Wikipedia]], но вполне можно сделать список устоявшихся. Справа делается скриншот. Внизу делается раздел "Ссылки" со следующими ссылками:
** Регистрация
** Регистрация
** Добавление контакта
** Добавление контакта
Строка 24: Строка 23:
** '''Подключение транспортов''' для страницы "Подключение транспортов"
** '''Подключение транспортов''' для страницы "Подключение транспортов"
* Ссылки на статьи с пользовательскими действиями размещать в описании соответствующих статей, т.е., "[[Пароль]]", "[[VCard]]" и т.д.
* Ссылки на статьи с пользовательскими действиями размещать в описании соответствующих статей, т.е., "[[Пароль]]", "[[VCard]]" и т.д.
* Скриншоты желательно размещать по центру либо в preview-виде. Удобным вариантом размещения скриншотов является галерея, размещенная по центру страницы. Другим вариантом является размещение превью скриншотов и текста рядом сними (так уж повелось, что обычно скриншот находится слева) - в виде пошагового руководства, при этом текст, описывающий скриншот, заканчивается шаблоном <nowiki>{{-}}</nowiki>. Не стоит загромождать один раздел скриншотами, возможно, стоит разнести описание по разным разделам.
* Скриншоты желательно размещать по центру либо в preview-виде. Удобным вариантом размещения скриншотов является галерея, размещенная по центру страницы с равномерным/симметричным размещением скриншотов <ref>Например, 2-3-4-8 скриншотов (в случае дефолтной ширины галереи в 4 скриншота) можно размещать без изменений, для 1 заводить галерею бессмысленно, для 5 можно ее немного растянуть, чтобы превью-картинки занимали одну строку, а не 2, для 6-7 - возможно, лучше разделить ее на 2 независимых блока</ref>. Другим вариантом является размещение превью скриншотов и текста рядом сними (так уж повелось, что обычно скриншот находится слева) - в виде пошагового руководства, при этом текст, описывающий скриншот, заканчивается шаблоном <nowiki>{{-}}</nowiki><ref>Иначе текст просто будет "съезжать" и будет находиться напротив других скриншотов</ref>. Не стоит загромождать один раздел скриншотами, возможно, стоит разнести описание по разным разделам.
* "Регистрация" подразумевает краткое вступление, скачивание, установку/запуск, описание процедуры создания нового аккаунта, выход в сеть, если этого требует клиент - заполнение [[VCard]].
* "Регистрация" подразумевает краткое вступление, скачивание, установку/запуск, описание процедуры создания нового аккаунта, выход в сеть, если этого требует клиент - заполнение [[VCard]]<ref>Хотя "принудительное" заполнения VCard было замечено только у Psi</ref>.
* В конце статьи по регистрации аккаунта необходимо добавить раздел "Ссылки" со ссылками на описания добавления пользователя, вход в конференцию и регистрацию транспортов (если клиент поддерживает данные функции).
* В конце статьи по регистрации аккаунта необходимо добавить раздел "Ссылки" со ссылками на описания добавления пользователя, вход в конференцию и регистрацию транспортов (если клиент поддерживает данные функции).
* "Вход в конференцию" описывается с учетом двух вариантов входа - через меню подключения к конференции и через работу с транспортами, если эти варианты поддерживаются клиентом.
* "Вход в конференцию" описывается с учетом двух вариантов входа - через меню подключения к конференции и через работу с транспортами, если эти варианты поддерживаются клиентом.
Строка 31: Строка 30:


Структуру статей рекомендуется изучать на примере уже готовых статей, например, описания [[Клиенты Jabber|Jabber-клиента]] [[Psi]].
Структуру статей рекомендуется изучать на примере уже готовых статей, например, описания [[Клиенты Jabber|Jabber-клиента]] [[Psi]].
'''Примечания:'''
<references />


[[Category:Участникам]]
[[Category:Участникам]]

Текущая версия на 10:00, 20 мая 2022

Если Вы хотите сделать описание для Jabber-клиента, который отсутствует на вики, то Вам пригодятся следующие указания:

  • Ссылка должна являться корректным именем клиента
  • Описание состоит из нескольких предложений, описывающих особенности данного клиента. Обычно неплохо Jabber-клиенты описываются на Wikipedia, поэтому на вступление можно ориентироваться там. Для уменьшения необходимости постоянного обслуживания страниц можно не описывать подробно все новейшие фичи клиентов, так как они постоянно меняются и хорошо описаны, к примеру, на Wikipedia, но вполне можно сделать список устоявшихся. Справа делается скриншот. Внизу делается раздел "Ссылки" со следующими ссылками:
    • Регистрация
    • Добавление контакта
    • Вход в конференцию
    • Обновление vCard
    • Смена пароля
    • Подключение транспортов
    • Настройка передачи файлов
    • ---любые дополнительные статьи--
    • Ссылка на официальный сайт
    • Ссылка на описание на Wikipedia
    • Описание на JRD-Wiki
  • Не стоит в названии каждой ссылки повторять название клиента, но страница, на которую идет ссылка, должна содержать имя клиента, т.е. ссылка формируется примерно так: [[Смена пароля в Клиент|Смена пароля]]. Т.е., попадая на данную страницу ты гарантированно видишь, к какому клиенту она относится.
  • Для статей используйте следующие категории:
    • Список категорий согласно поддерживаемым ОС для страницы-описания клиента
    • Регистрация для страницы регистрациия в клиенте
    • Пользовательские действия для страниц "Добавление контакта", "Вход в конференцию", "Обновление vCard", "Смена пароля", "Подключение транспортов"
    • Вход в конференцию для страницы "Вход в конференцию"
    • Настройка передачи файлов для страницы "Настройка передачи файлов"
    • Подключение транспортов для страницы "Подключение транспортов"
  • Ссылки на статьи с пользовательскими действиями размещать в описании соответствующих статей, т.е., "Пароль", "VCard" и т.д.
  • Скриншоты желательно размещать по центру либо в preview-виде. Удобным вариантом размещения скриншотов является галерея, размещенная по центру страницы с равномерным/симметричным размещением скриншотов [1]. Другим вариантом является размещение превью скриншотов и текста рядом сними (так уж повелось, что обычно скриншот находится слева) - в виде пошагового руководства, при этом текст, описывающий скриншот, заканчивается шаблоном {{-}}[2]. Не стоит загромождать один раздел скриншотами, возможно, стоит разнести описание по разным разделам.
  • "Регистрация" подразумевает краткое вступление, скачивание, установку/запуск, описание процедуры создания нового аккаунта, выход в сеть, если этого требует клиент - заполнение VCard[3].
  • В конце статьи по регистрации аккаунта необходимо добавить раздел "Ссылки" со ссылками на описания добавления пользователя, вход в конференцию и регистрацию транспортов (если клиент поддерживает данные функции).
  • "Вход в конференцию" описывается с учетом двух вариантов входа - через меню подключения к конференции и через работу с транспортами, если эти варианты поддерживаются клиентом.
  • Списки ссылок выделять маркером (как, например, весь этот список, т.е. "*")

Структуру статей рекомендуется изучать на примере уже готовых статей, например, описания Jabber-клиента Psi.

Примечания:

  1. ↑ Например, 2-3-4-8 скриншотов (в случае дефолтной ширины галереи в 4 скриншота) можно размещать без изменений, для 1 заводить галерею бессмысленно, для 5 можно ее немного растянуть, чтобы превью-картинки занимали одну строку, а не 2, для 6-7 - возможно, лучше разделить ее на 2 независимых блока
  2. ↑ Иначе текст просто будет "съезжать" и будет находиться напротив других скриншотов
  3. ↑ Хотя "принудительное" заполнения VCard было замечено только у Psi
Источник — https://jabberworld.info/index.php?title=Справка:Описания_клиентов&oldid=9722