diff --git a/.github/workflows/dev-deploy.yml b/.github/workflows/dev-deploy.yml index f6a2978..2a0de9b 100644 --- a/.github/workflows/dev-deploy.yml +++ b/.github/workflows/dev-deploy.yml @@ -1,4 +1,4 @@ -name: Build docs +name: Build and deploy dev docs on: push: @@ -29,7 +29,7 @@ jobs: - name: Build static files run: | cd docs - make html + make html-all - name: Upload build artifact uses: actions/upload-artifact@v5.0.0 diff --git a/.github/workflows/prod-deploy.yml b/.github/workflows/prod-deploy.yml index c75c24a..f27b495 100644 --- a/.github/workflows/prod-deploy.yml +++ b/.github/workflows/prod-deploy.yml @@ -1,4 +1,4 @@ -name: Build docs +name: Build and deploy prod docs on: push: @@ -27,7 +27,7 @@ jobs: - name: Build static files run: | cd docs - make html + make html-all - name: Upload build artifact uses: actions/upload-artifact@v5.0.0 diff --git a/README.md b/README.md index d53d461..a4f2ca2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # joinrpg-docs -[![Documentation Status](https://readthedocs.org/projects/joinrpg/badge/?version=latest)](http://joinrpg.readthedocs.io/ru/latest/?badge=latest) +Linter warnings and errors: +Actions - Build sphinx docs job - Build static files step In this repository we have documentation for joinrpg. See http://docs.joinrpg.ru. Maintainers: @tsareva, @dtrub diff --git a/docs/Makefile b/docs/Makefile index 17df1c3..aad8395 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -54,6 +54,17 @@ html: @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." +.PHONY: html-old +html-old: + $(SPHINXBUILD) -b html -D html_baseurl='/ru/latest/' $(ALLSPHINXOPTS) $(BUILDDIR)/html/ru/latest + @echo + @echo "Old link style version for backward compatibility built in $(BUILDDIR)/html/ru/latest" + +.PHONY: html-all +html-all: html html-old + @echo + @echo "Build finished. HTML pages available at / and /ru/latest" + .PHONY: dirhtml dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml diff --git a/docs/accommodation/rooms_for_participants.rst b/docs/accommodation/rooms_for_participants.rst index 9d47aba..a57fdac 100644 --- a/docs/accommodation/rooms_for_participants.rst +++ b/docs/accommodation/rooms_for_participants.rst @@ -1,5 +1,5 @@ Расселение участников -======================= +===================== Для того, чтобы определить проживание участников в конкретных комнатах с конкретными соседями, воспользуйтесь меню **Прочее > Настройки > Поселение > (иконка «расселение» у нужного типа комнаты)** @@ -8,7 +8,7 @@ :align: center :alt: Список комнат - .. attetion:: Проживание назначается для **человека**, а не для персонажа. В случае смены игрока на роли новому игроку потребуется назначить тип проживания заново. +.. attention:: Проживание назначается для **человека**, а не для персонажа. В случае смены игрока на роли новому игроку потребуется назначить тип проживания заново. В комнату нельзя записать больше проживающих, чем мест в каждой комнате этого типа размещения. При заселении в комнату и добавлении новых соседей заявившиеся получают уведомления на электронную почту, также эта информация показывается в заявке в блоке «Проживание». @@ -20,7 +20,7 @@ .. attention:: Список соседей со ссылкой на профиль joinrpg будет виден всем проживающим в этой комнате. Избегайте спойлеров для игроков! Список участников для типа размещения ---------------------------------- +------------------------------------- На вкладке «Комнаты» типа размещения показываются все участники, в заявках которых указан этот тип. Сверху располагаются те, кто еще не приписан к конкретной комнате; те, чье проживание определено, расположены в ячейках соответствующих помещений. Каждая заявка сопровождается указанием, сколько из назначенной к оплате суммы (включая оргвзнос, цену за место проживания, другие выбранные опции) еще осталось оплатить. @@ -31,7 +31,7 @@ Массовое заселение / выселение ---------------------------------- +------------------------------ .. figure:: in_or_out.JPG :scale: 100 % @@ -46,7 +46,7 @@ Функция «Выселить всех» также доступна на странице со списком типов размещения. При ее использовании будут освобождены все комнаты всех типов разменения Выбор проживающих для каждой комнаты --------------------------------------- +------------------------------------ .. figure:: in_for_room.JPG :scale: 100 % diff --git a/docs/api/integration.rst b/docs/api/integration.rst index d5f3dfb..43873fb 100644 --- a/docs/api/integration.rst +++ b/docs/api/integration.rst @@ -1,11 +1,11 @@ Интеграция ИТ систем -======================== +==================== Данный документ призван обобщить опыт игр Deus Ex и Магеллан по тому, как удобно и правильно интегрировать бекенд вашей игры и joinrpg. Предназначен для мастеров, у которых на игре есть некая ИТ-система, предоставляющая возможности в рамках игрового мира. В дальнейшем будем называть ее Система. Привязка всего к персонажу ------------------------ +-------------------------- .. note:: Эти принципы мы считаем разумными для всех интеграций Источником правды о персонажах на начало игры является данные из joinrpg. Это даст мастерам возможность вести всю информацию по игре в одном месте, использовать удобные и привычные инструменты для управления. @@ -17,7 +17,7 @@ 3. На игре менять роль игроку (выпуск второй ролью). Поля персонажа ------ +-------------- Для хранения всех данных по персонажу надо использовать поля персонажа. В API это называется ``CharacterFields``. Обратите внимание, что дополнительные данные по полям (например, метаданные по вариантам выпадаек) можно хранить в поле ``ProgrammaticalValue`` и загрузить при помощи `MetaDataApi_GetFieldsList `_. @@ -30,28 +30,29 @@ 2. Использовать «красивый», игровой логин, который берется из какого-то поля персонажа, например ``dartvader@empire.local`` Пароль ------ +------ Пароль в вашу систему рекомендуем хранить в поле персонажа типа PIN-код. Он будет создан автоматически (но при желании вы сможете вручную его отредактировать). «В игре» -------- +-------- У персонажа есть флаг «В игре» — ``InGame``: - становится ``true``, если игрок прошел регистрацию на игре; - становится ``false``, если игрок был выпущен новой ролью. В идеале он мог бы становится false, если бы Система сообщала joinrpg о смерти персонажа, но такой функционал не был реализован. + Для NPC он всегда ``false``, их надо обрабатывать отдельно (`#1034 `_) Использование joinrpg в качестве бекенда ------------- +---------------------------------------- Не рекомендуется использовать joinrpg в качестве непосредственного бекенда для вашего приложения. Мы не гарантируем соблюдения ваших требований по нагрузке и надежности. Правильный вариант, чтобы бекендом для вашего приложения был ваш сервис с вашей базой, который работает независимо от joinrpg. Впрочем, если вы всегда запрашиваете данные `по одному персонажу по его Id `_, количество запросов не превышает сотен в час и вы готовы обеспечить стабильный канал до joinrpg, то это можно использовать как основной вариант. Преимущества: нет проблемы синхронизации. Заливка Excel --------------- +------------- .. note:: Подходит только для простых ИТ-систем и маленьких игр. @@ -68,7 +69,7 @@ - не подходит, если игра большая (формирование Excel займет определенное время). Онлайн-импорт ------------------ +------------- .. note:: Мы рекомендуем этот вариант для сложных ИТ-систем diff --git a/docs/characters/slots.rst b/docs/characters/slots.rst index 6ee234a..dfc54b6 100644 --- a/docs/characters/slots.rst +++ b/docs/characters/slots.rst @@ -1,7 +1,7 @@ .. _character-slot-label: Шаблоны персонажей -============ +================== Шаблон персонажей - мастерский инструмент позволяющий создать одного персонажа (собственно, шаблон) на основании которого, при принятии заявки, будут созданы отдельные персонажи. Шаблону персонажей можно присваивать поля (в том числе и с предустановленным значением) и привязывать группы. diff --git a/docs/checkin/during.rst b/docs/checkin/during.rst index ec436b5..db29342 100644 --- a/docs/checkin/during.rst +++ b/docs/checkin/during.rst @@ -1,5 +1,5 @@ Включение регистрации на полигоне -======================== +================================= Чтобы начать регистрацию приезжающих на игру, пройдите в своем проекте: **Прочее > Настройки > Настройки регистрации** @@ -33,7 +33,7 @@ :align: center :alt: Экран регистрации -На экране регистрации выводится список `раздатки `_ — физических вещей, которые получает игрок на полигоне непосредственно перед игрой. В том случае, если вы не формировали конверты для игроков заранее, игрок может получить требуемые вещи по этому списку прямо на регистрации. +На экране регистрации выводится список `раздатки `_ — физических вещей, которые получает игрок на полигоне непосредственно перед игрой. В том случае, если вы не формировали конверты для игроков заранее, игрок может получить требуемые вещи по этому списку прямо на регистрации. После нажатия кнопки «Зарегистрировать игрока» статус заявки меняется на «Игрок заехал», она учитывается в списке зарегистированных игроков и больше не отображается в списке персонажей, доступных для регистрации. В заявке автоматически оставляется комментарий «Пройдена регистрация на полигоне» от имени зарегистрировавшего мастера. diff --git a/docs/checkin/second-roles.rst b/docs/checkin/second-roles.rst index f4f62ba..5b2baaf 100644 --- a/docs/checkin/second-roles.rst +++ b/docs/checkin/second-roles.rst @@ -8,7 +8,7 @@ Выберите опцию «Разрешить выпуск вторыми ролями». Сохраните настройки. -Выпустить второй ролью можно только игрока, первая заявка которого на игру прошла `процесс регистрации `_. Непринятые заявки и незарегистрированных игроков выпустить второй ролью нельзя. +Выпустить второй ролью можно только игрока, первая заявка которого на игру прошла `процесс регистрации `_. Непринятые заявки и незарегистрированных игроков выпустить второй ролью нельзя. .. figure:: new_role.png :scale: 100 % @@ -25,7 +25,7 @@ :align: center :alt: Поиск по имени персонажа -После нажатия кнопки «Выпустить второй ролью» вы перейдете в интерфейс регистрации игрока новым персонажем. В том случае, если у персонажа, которым вы пытаетесь выпустить второй ролью, не заполнены какие-то обязательные поля, регистрация будет невозможна, но заявка уже будет привязана к этому персонажу. Перейдите на страницу персонажа и заполните все обязательные и рекомендуемые поля персонажа, `повторно пройдите процесс регистрации на полигоне `_ для автоматически созданной заявки во второй роли. +После нажатия кнопки «Выпустить второй ролью» вы перейдете в интерфейс регистрации игрока новым персонажем. В том случае, если у персонажа, которым вы пытаетесь выпустить второй ролью, не заполнены какие-то обязательные поля, регистрация будет невозможна, но заявка уже будет привязана к этому персонажу. Перейдите на страницу персонажа и заполните все обязательные и рекомендуемые поля персонажа, `повторно пройдите процесс регистрации на полигоне `_ для автоматически созданной заявки во второй роли. .. hint:: Через меню Персонажи > Проблемные персонажи мастера могут заранее заполнить недостающие поля, тогда выпуск новыми ролями будет происходить максимально оперативно. diff --git a/docs/checkin/statistic.rst b/docs/checkin/statistic.rst index e6c4e48..71c2c25 100644 --- a/docs/checkin/statistic.rst +++ b/docs/checkin/statistic.rst @@ -1,5 +1,5 @@ Статистика зарегистрированных -======================== +============================= Статистика по ходу регистрации доступна по ссылке **Прочее > Регистрация > Статистика по регистрации**. Показывается число принятых заявок, еще не прошедших регистрацию. diff --git a/docs/communication/claim_comments.rst b/docs/communication/claim_comments.rst index 5e7ba35..26ca91d 100644 --- a/docs/communication/claim_comments.rst +++ b/docs/communication/claim_comments.rst @@ -1,16 +1,16 @@ Комментарии в заявке -======================== +==================== Для комментариев в заявке используется древовидная система: все сообщения расположены иерархично, в зависимости от того, на какой конкретно комментарий был дан ответ. Если при отправке комментария не указано иное, то он будет виден и мастерам, и игроку. -Комментарии сохраняются за конкретной заявкой (не будут видны новому игроку для того же персонажа), не публикуются при `публикации игровых материалов после игры `_. +Комментарии сохраняются за конкретной заявкой (не будут видны новому игроку для того же персонажа), не публикуются при `публикации игровых материалов после игры `_. -Игроку приходят уведомления о любых видимых ему комментариях на e-mail. Ответственному за заявку мастеру приходят любые комментарии (как от игрока, так и от других мастеров). Остальные мастера `могут подписаться на уведомления о новых комментариях `_; также уведомления приходят тому мастеру, на комментарий которого вы отвечаете, вне зависимости от его личных настроек уведомлений. +Игроку приходят уведомления о любых видимых ему комментариях на e-mail. Ответственному за заявку мастеру приходят любые комментарии (как от игрока, так и от других мастеров). Остальные мастера `могут подписаться на уведомления о новых комментариях `_; также уведомления приходят тому мастеру, на комментарий которого вы отвечаете, вне зависимости от его личных настроек уведомлений. Автоматические комментарии ---------------------------------- +-------------------------- Большинство значимых операций с заявкой (изменение статуса заявки, информация об отправке игроком и приеме мастером взноса) сопровождается комментарием, который остается в заявке. Такие комментарии имеют выделенный жирным заголовок — название операции, которая была произведена. Старайтесь оставлять значимые комментарии, которые помогут вам в будущем или другому мастеру понять, почему было то или иное решение (например, причины, по которым заявка была отклонена — даже если вы отклоняете «по просьбе игрока»). @@ -28,10 +28,10 @@ :align: center :alt: Финансовые комментарии -Для информирования мастеров о сдаче взноса пользуйтесь `специальной функцией `_, а не обычными комментариями. +Для информирования мастеров о сдаче взноса пользуйтесь `специальной функцией `_, а не обычными комментариями. Скрытые комментарии, видимые мастерам ------------------------- +------------------------------------- Скрытые комментарии видны только другим мастерам (людям, у которых есть доступ в проект). Уведомления о скрытых комментариях приходят только тем мастерам, которые подписаны на комментарии к этой заявке или на чей комментарий оставляется ответ. Чтобы оставить скрытый комментарий, перед отправкой отметьте чекбокс «только для мастеров». @@ -48,7 +48,7 @@ :alt: Комментарий мастерам Как скрыть ошибочно оставленный комментарий ---------------------------------------------- +------------------------------------------- Комментарий, который был по ошибке оставлен игроку, но предназначался для мастеров, можно на странице заявки скрыть: diff --git a/docs/communication/forums.rst b/docs/communication/forums.rst index 9735c08..591f560 100644 --- a/docs/communication/forums.rst +++ b/docs/communication/forums.rst @@ -1,5 +1,5 @@ Форумы -======================== +====== Форумы полезны для подготовки групп игроков, которые заявляются отдельно, но должны обсудить какие-то общие завязки. Как и комментарии в заявке, каждый форум имеет древовидную структуру с иерархией сообщений. @@ -16,7 +16,7 @@ .. attention:: Доступ к уже открытому форуму нельзя отредактировать, т.е. нельзя переназначить форум другой группе или скрыть его от всех кроме мастеров. Общие настройки нового форума ---------------------------------- +----------------------------- Каждый новый форум имеет заголовок и стартовое сообщение. И то, и другое видно всем, у кого есть доступ к этому форуму. Чтобы легче ориентироваться в списке форумов, советуем давать им значимые названия для облегчения навигации. Если вы хотите, чтобы всем участникам пришло уведомление об открытии нового форума — выберите пункт «уведомить по e-mail». @@ -30,7 +30,7 @@ .. hint:: Если форум предназначен для конкретной группы — удобно обозначить это в названии («Королевство Аэдирн: обсуждение завязок», «Хакеры: обсуждение внутренних правил», «Цинтра: строяк крепости» и т.п.), так как на странице со всеми форумами группа не показывается. Как завести новый форум для всех игроков ------------------------------------- +---------------------------------------- Доступные всем игрокам форумы можно заводить через меню группы «Все роли» или на странице всех форумов. @@ -49,9 +49,9 @@ :alt: Новый форум для всех через Все роли Как завести новый форум для группы ------------------------------------- +---------------------------------- -Форумы можно заводить для любой `группы `_ или `специальной группы `_). Вкладка «Форумы» доступна в общих настройках группы (перейдите к ним кликом по названию группы). +Форумы можно заводить для любой `группы `_ или `специальной группы `_). Вкладка «Форумы» доступна в общих настройках группы (перейдите к ним кликом по названию группы). .. figure:: forum_for_group.jpg :scale: 100 % @@ -76,7 +76,7 @@ :alt: Новый форум для Мастеров Примеры, как форумы выглядят для игроков --------------------------------------------- +---------------------------------------- Форумы, к которым у игрока есть доступ, показываются ему на странице всех активных форумов. К ней можно перейти через меню **Форумы > Все активные**. diff --git a/docs/communication/index.rst b/docs/communication/index.rst index 22b7830..d30c677 100644 --- a/docs/communication/index.rst +++ b/docs/communication/index.rst @@ -1,7 +1,7 @@ Общение и уведомления -============ +===================== -Мы стремимся к тому, чтобы максимум общения, связанного с подготовкой к игре, проходило через базу заявок. Общение игрока с мастером (или мастерами) происходит в его заявке, а для общения игроков друг с другом созданы форумы, привязанные к группам сетки ролей (можно создавать их для «всех игроков в Лондоне», «всех эльфов» и т.п. — любой `группы `_ или `специальной группы `_). +Мы стремимся к тому, чтобы максимум общения, связанного с подготовкой к игре, проходило через базу заявок. Общение игрока с мастером (или мастерами) происходит в его заявке, а для общения игроков друг с другом созданы форумы, привязанные к группам сетки ролей (можно создавать их для «всех игроков в Лондоне», «всех эльфов» и т.п. — любой `группы `_ или `специальной группы `_). Плюсы обсуждения всех вопросов, связанных с игрой, через базу заявок: diff --git a/docs/communication/subscriptions.rst b/docs/communication/subscriptions.rst index f5f332a..4525fdf 100644 --- a/docs/communication/subscriptions.rst +++ b/docs/communication/subscriptions.rst @@ -52,6 +52,6 @@ :align: center :alt: Подписка из заявки -.. hint:: Если нужной группы нет, а нужно подписаться на много тематических заявок (например, всех магов, медиков, эльфов) — то такую группу точно стоит создать. Она может быть как частью сетки ролей (возможно, скрытой от игроков), так и специальной — автоматически создаваемой на основании проставленных значений полей персонажа («специальные способности», «раса» и т.п.). `Как создавать группы и с ними работать — можно почитать в разделе «Группы» `_. +.. hint:: Если нужной группы нет, а нужно подписаться на много тематических заявок (например, всех магов, медиков, эльфов) — то такую группу точно стоит создать. Она может быть как частью сетки ролей (возможно, скрытой от игроков), так и специальной — автоматически создаваемой на основании проставленных значений полей персонажа («специальные способности», «раса» и т.п.). `Как создавать группы и с ними работать — можно почитать в разделе «Группы» `_. .. attention:: Не используйте подписки на отдельные заявки в том случае, если вы региональный мастер или мастер по направлению. Велик шанс при ручной настройке подписки пропустить нужную заявку! Воспользуйтесь советом выше и подпишитесь на группу. diff --git a/docs/conf.py b/docs/conf.py index cfdeb01..02d3c69 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -87,7 +87,11 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build', + 'Thumbs.db', + '.DS_Store', + 'howto-doc.md', + 'markdown.md'] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -160,7 +164,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/fields/character_vs_application.rst b/docs/fields/character_vs_application.rst index f25bc90..d01b245 100644 --- a/docs/fields/character_vs_application.rst +++ b/docs/fields/character_vs_application.rst @@ -3,7 +3,7 @@ При создании нового поля требуется выбрать, к какой сущности оно будет привязано: персонажу или к заявке. Это свойство нельзя редактировать у существующих полей. -**Персонаж** — это всё, что связано с персонажем ролевой игры: его умения, особенности, предыстория. Поля, привязанные к персонажу, содержат информацию, которую мастер может заполнять до появления конкретного игрока и/или хочет передать к новому игроку на этой роли (даже если это поле было заполнено игроком-предшественником). Поля персонажа формируют `специальные группы `_ и могут использоваться для создания сетки ролей. +**Персонаж** — это всё, что связано с персонажем ролевой игры: его умения, особенности, предыстория. Поля, привязанные к персонажу, содержат информацию, которую мастер может заполнять до появления конкретного игрока и/или хочет передать к новому игроку на этой роли (даже если это поле было заполнено игроком-предшественником). Поля персонажа формируют `специальные группы `_ и могут использоваться для создания сетки ролей. **Заявка** — всё, что связано с конкретным игроком: пожелания по завязкам, направлению игры, номер автомобиля для проезда на базу, дополнительное питание и т.п. После отклонения принятой заявки они не будут доступны новому игроку на этой роли. Заполненные для заявки поля НЕ формируют специальные группы, по ним доступен только отчет по заявкам с незаполненным полем. diff --git a/docs/fields/field_types.rst b/docs/fields/field_types.rst index e34fec5..8532f05 100644 --- a/docs/fields/field_types.rst +++ b/docs/fields/field_types.rst @@ -10,11 +10,11 @@ Также на этой странице можно изменить порядок вывода полей — подвинуть конкретное поле на одно деление вверх/вниз (поменять местами с соседним) или изменить положение относительно других полей (поставить в начало, в конец или после конкретного поля). -.. attention:: Если эти кнопки вам не видны, а добавление новых полей недоступно — у вас нет `права настраивать поля для проекта `_. +.. attention:: Если эти кнопки вам не видны, а добавление новых полей недоступно — у вас нет `права настраивать поля для проекта `_. **Тип поля** — что это за поле. Нельзя менять после создания поля. -**Привязано к персонажу / заявке**. `Подробнее про разницу между персонажем и заявкой `_. Нельзя менять после создания поля. +**Привязано к персонажу / заявке**. `Подробнее про разницу между персонажем и заявкой `_. Нельзя менять после создания поля. **Обязательное?** — задает возможность сохранять персонажа/заявку, если это поле не заполнено. @@ -28,7 +28,7 @@ * *Рекомендованное* — никакие действия не блокируются, но заявки с незаполненными рекомендованными полями особым образом помечаются в общем списке, для мастеров есть возможность отфильтровать все заявки или всех персонажей, у которых не заполнено конкретное поле. * *Опциональное* — обычное поле без требований по обязательности, заявки с незаполненными опциональными полями никак не выделяются. -Как обязательные, так и рекомендованные поля используются при проверке, готова ли заявка к `прохождению регистрации `_. +Как обязательные, так и рекомендованные поля используются при проверке, готова ли заявка к `прохождению регистрации `_. **Публичное** — поле видно на карточке персонажа всем. Пример карточки персонажа с некоторыми общедоступными полями (в данном случае возраст персонажа и младший родственник общеизвестны): @@ -64,7 +64,7 @@ :align: center :alt: Описание поля для мастера -**Показывать только для групп** — поле будет показываться только для `определенной группы `_ (например, список заклинаний — только для магов). Есть два сценария использования: +**Показывать только для групп** — поле будет показываться только для `определенной группы `_ (например, список заклинаний — только для магов). Есть два сценария использования: * Для выделения секретной информации для определенной группы — требует показывать для игроков с утвержденной заявкой. В таком случае флаг «Показывать даже при непринятой заявке» должен быть пустым. * Для описания специфики группы — в таком случае этот флаг может как стоять, так и отсутствовать (в зависимости от того, хотите ли вы показывать это поле при подаче заявки). diff --git a/docs/fields/filter_by_field.rst b/docs/fields/filter_by_field.rst index e851648..1f910d1 100644 --- a/docs/fields/filter_by_field.rst +++ b/docs/fields/filter_by_field.rst @@ -1,7 +1,7 @@ Фильтры по значениям полей ==================================== -Поля персонажа типов «выбор» и «мультивыбор» автоматически формируют `специальные группы `_, отображающиеся как часть сетки ролей. +Поля персонажа типов «выбор» и «мультивыбор» автоматически формируют `специальные группы `_, отображающиеся как часть сетки ролей. .. figure:: filter_by_meaning.PNG :width: 100 % diff --git a/docs/fields/index.rst b/docs/fields/index.rst index 33ee44f..dccebdb 100644 --- a/docs/fields/index.rst +++ b/docs/fields/index.rst @@ -1,9 +1,9 @@ Поля персонажа / заявки ========================= -При `создании новой базы заявок `_ предлагаются два шаблона — набора настроек, оптимальным образом подобранных для типа проекта. Таким образом, ряд настроек для полей заявки / персонажа создается автоматически по выбранному шаблону. +При `создании новой базы заявок `_ предлагаются два шаблона — набора настроек, оптимальным образом подобранных для типа проекта. Таким образом, ряд настроек для полей заявки / персонажа создается автоматически по выбранному шаблону. -1. Для **ролевой игры** появятся поля «Имя персонажа» и «Описание персонажа», используемые в сетке ролей. В дальнейшем можно поменять их название в `редактировании полей заявки `_ или назначить для демонстрации в сетке ролей другие поля `через настройки `_. +1. Для **ролевой игры** появятся поля «Имя персонажа» и «Описание персонажа», используемые в сетке ролей. В дальнейшем можно поменять их название в `редактировании полей заявки `_ или назначить для демонстрации в сетке ролей другие поля `через настройки `_. 2. У **конвента** сетка ролей формируется по-другому: все заявки принимаются автоматически, «имя персонажа» берется из ника или имени игрока в профиле, описание отсутствует. После создания базы заявок настройки, заданные шаблоном, можно поменять в настройках проекта (только для продвинутых пользователей). diff --git a/docs/fields/settings_for_role_list.rst b/docs/fields/settings_for_role_list.rst index 0551ea6..b9d475a 100644 --- a/docs/fields/settings_for_role_list.rst +++ b/docs/fields/settings_for_role_list.rst @@ -1,5 +1,5 @@ Использование полей в сетке ролей -===================================== +================================= Общие настройки полей проекта задают, какие поля и каким образом используются при формировании сетки ролей. По умолчанию в этом разделе все настроено оптимальным образом согласно выбору при создании проекта (игра/конвент). Изменяйте эти настройки, если уверены, что понимаете, как работает этот раздел и чего бы хотелось достичь. При сомнениях — пишите на support@joinrpg.ru или в сообщения `сообщества Вконтакте `_. @@ -7,18 +7,18 @@ По умолчанию игрок не может менять ни имя персонажа, ни описание. Вы можете разрешить это игрокам в настройках соответствующих полей. -Имя персонажа может быть привязано к любому полю **персонажа**, которое имеет `тип «Строка» `_, или браться из ника/ФИО игрока. К полям заявки привязать имя персонажа нельзя. +Имя персонажа может быть привязано к любому полю **персонажа**, которое имеет `тип «Строка» `_, или браться из ника/ФИО игрока. К полям заявки привязать имя персонажа нельзя. По умолчанию принять заявку без имени персонажа нельзя. -.. warning:: Если поле с именем персонажа было изменено мастерами так, что стало доступно к редактированию игроком при непринятой заявке (см. подробнее в разделе про `настройки полей `_) — подать заявку без его заполнения будет нельзя. Советуем изменять в таком случае настройку «Обязательное?» на «рекомендованное». +.. warning:: Если поле с именем персонажа было изменено мастерами так, что стало доступно к редактированию игроком при непринятой заявке (см. подробнее в разделе про `настройки полей `_) — подать заявку без его заполнения будет нельзя. Советуем изменять в таком случае настройку «Обязательное?» на «рекомендованное». -.. tips:: Это может привести к появлению в сетке ролей персонажей с именами «потом», «придумаю позже» и т.п. Будьте внимательны при приеме заявок! +.. tip:: Это может привести к появлению в сетке ролей персонажей с именами «потом», «придумаю позже» и т.п. Будьте внимательны при приеме заявок! -Описание персонажа может быть привязано к любому полю **персонажа**, которое имеет `тип «Текст» `_. К полям заявки его привязать нельзя. +Описание персонажа может быть привязано к любому полю **персонажа**, которое имеет `тип «Текст» `_. К полям заявки его привязать нельзя. Назначение нового поля как имени / описания персонажа ------------------------------------------------------------------ +----------------------------------------------------- Изменить поле, используемое как имя персонажа, можно через **Прочее > Поля персонажа / заявки** и плашку **«Настройки полей»**. diff --git a/docs/finance/discount.rst b/docs/finance/discount.rst index 1c1d322..87d996c 100644 --- a/docs/finance/discount.rst +++ b/docs/finance/discount.rst @@ -3,7 +3,7 @@ Для некоторых категорий игроков можно принимать пониженные взносы. Мы рекомендуем предоставлять скидку студентам дневных отделений и школьникам. -Чтобы включить возможность запросить льготный взнос для игроков, перейдите **Финансы/АХЧ > Настройка финансов** и выберите пункт **Общие настройки**. Поставьте галочку «Включить льготный взнос» и укажите какие-то условия, при которых он предоставляется. Эти условия будут видны игроку `при нажатии на кнопку «Запросить льготу» в его заявке `_. +Чтобы включить возможность запросить льготный взнос для игроков, перейдите **Финансы/АХЧ > Настройка финансов** и выберите пункт **Общие настройки**. Поставьте галочку «Включить льготный взнос» и укажите какие-то условия, при которых он предоставляется. Эти условия будут видны игроку `при нажатии на кнопку «Запросить льготу» в его заявке `_. .. figure:: discount.PNG :align: center @@ -25,7 +25,7 @@ Подтверждение запрошенной льготы --------------------------------------- -Уведомления о запросах льготы от игроков приходят всем мастерам, `подписанным на финансовые операции `_. Комментарий с запросом льготы появляется в заявке игрока: +Уведомления о запросах льготы от игроков приходят всем мастерам, `подписанным на финансовые операции `_. Комментарий с запросом льготы появляется в заявке игрока: .. figure:: comment_discount.PNG :width: 70 % diff --git a/docs/finance/notification.rst b/docs/finance/notification.rst index b2aee1d..2168469 100644 --- a/docs/finance/notification.rst +++ b/docs/finance/notification.rst @@ -4,7 +4,7 @@ Отметить оплату --------------- -Игрок может отметить факт сдачи взноса в верхней части своей заявки. Подробно об этом расписано в `Как отметить факт сдачи взноса `_. +Игрок может отметить факт сдачи взноса в верхней части своей заявки. Подробно об этом расписано в `Как отметить факт сдачи взноса `_. Оповещение об отметке взноса придет на емейл мастера, за которым закреплена данная заявка, а также подписанным на нее мастерам. diff --git a/docs/finance/payment.rst b/docs/finance/payment.rst index fc7a149..370cc2d 100644 --- a/docs/finance/payment.rst +++ b/docs/finance/payment.rst @@ -3,7 +3,7 @@ Настройка размера и срока действия ---------------------------------- -Для получения возможности настройки взносов у мастера должны быть проставлены соответствующие `права `_ в разделе **Прочее > Мастера**. +Для получения возможности настройки взносов у мастера должны быть проставлены соответствующие `права `_ в разделе **Прочее > Мастера**. Чтобы задать размер взноса, перейдите в своем проекте: **Финансы/АХЧ > Настройка финансов > Взнос и сроки**. Дальше нажмите «Добавить нужный размер взноса». @@ -24,7 +24,7 @@ ------------- На joinrpg.ru есть несколько опций приема взносов. -**«Онлайн»** - подробно об этой возможности вы можете прочитать в разделе `Прием платежей онлайн `_. +**«Онлайн»** - подробно об этой возможности вы можете прочитать в разделе `Прием платежей онлайн `_. **«Безналичный метод»** - переводы с карты на карту. Так как разные мастерские группы могут использовать разное количество и виды карт для приема взносов, для указания возможных вариантов безналичной оплаты необходимо воспользоваться кнопкой «Добавить метод оплаты». diff --git a/docs/finance/settings.rst b/docs/finance/settings.rst index f2a2aac..dfa8de2 100644 --- a/docs/finance/settings.rst +++ b/docs/finance/settings.rst @@ -3,4 +3,4 @@ В разделе **Финансы/АХЧ > Настройка финансов > Общие настройки** есть такие настройки: * «Предупреждать о переплате в заявках» - мастерам будет выводиться оповещение в случае, если в заявке заплачено больше установленного взноса. -* «Включить льготный взнос» - подробно об этой опции вы можете прочитать в `Льготные взносы `_. \ No newline at end of file +* «Включить льготный взнос» - подробно об этой опции вы можете прочитать в `Льготные взносы `_. \ No newline at end of file diff --git a/docs/finance/statistics.rst b/docs/finance/statistics.rst index ecf5f08..4c346d7 100644 --- a/docs/finance/statistics.rst +++ b/docs/finance/statistics.rst @@ -13,7 +13,7 @@ Неоплаченные принятые заявки ---------------------------- -В разделе **Финансы/АХЧ > Неоплаченные принятые заявки** мастер может получить список заявок, которые находятся в статусах «Принята» или `«Игрок заехал» `_, но при этом взнос игроком не сдан. Также имеется возможность скачать данный список в Excel-файл или же осуществить массовую рассылку писем на емейл соответствующих игроков. +В разделе **Финансы/АХЧ > Неоплаченные принятые заявки** мастер может получить список заявок, которые находятся в статусах «Принята» или `«Игрок заехал» `_, но при этом взнос игроком не сдан. Также имеется возможность скачать данный список в Excel-файл или же осуществить массовую рассылку писем на емейл соответствующих игроков. .. note:: Так как список таких игроков на полигоне может интересовать мастеров по АХЧ в первую очередь, на странице имеется возможность сразу же отправить на печать список неоплаченных принятых заявок. diff --git a/docs/for_players/contacts.rst b/docs/for_players/contacts.rst index 348eff1..cf3ca19 100644 --- a/docs/for_players/contacts.rst +++ b/docs/for_players/contacts.rst @@ -16,7 +16,7 @@ :align: center :alt: Публичность контактов -.. hint:: `Через вводные `_ мастера могут показывать контакты игроков друг другу, даже если в профиле они скрыты. Эти контакты также скрываются после закрытия проекта. +.. hint:: `Через вводные `_ мастера могут показывать контакты игроков друг другу, даже если в профиле они скрыты. Эти контакты также скрываются после закрытия проекта. Уведомления в Телеграм diff --git a/docs/for_players/discount.rst b/docs/for_players/discount.rst index c44108a..6b5e77b 100644 --- a/docs/for_players/discount.rst +++ b/docs/for_players/discount.rst @@ -1,7 +1,7 @@ Как запросить скидку на взнос ================================= -В некоторых проектах настроена возможность запросить льготу — пониженный взнос для определенных категорий игроков. Если такая опция предусмотрена мастерами, то рядом с суммой взноса и кнопкой `«Отметить оплату» `_ есть еще одна кнопка, «Запросить льготу»: +В некоторых проектах настроена возможность запросить льготу — пониженный взнос для определенных категорий игроков. Если такая опция предусмотрена мастерами, то рядом с суммой взноса и кнопкой `«Отметить оплату» `_ есть еще одна кнопка, «Запросить льготу»: .. figure:: ask_for_discount.PNG :width: 70 % diff --git a/docs/for_players/index.rst b/docs/for_players/index.rst index 279ad2e..52b1250 100644 --- a/docs/for_players/index.rst +++ b/docs/for_players/index.rst @@ -1,5 +1,5 @@ Полезно игрокам -============ +=============== В первую очередь JoinRPG облегчает мастерскую работу, но есть несколько фич, которые будут полезны и игрокам. Информацию о них мы собираем в этом разделе. @@ -10,7 +10,7 @@ :maxdepth: 3 contacts - inform_about_payment + inform_about_payment pay_online discount print_claim diff --git a/docs/for_players/inform_about_payment.rst b/docs/for_players/inform_about_payment.rst index 2b90177..e698a73 100644 --- a/docs/for_players/inform_about_payment.rst +++ b/docs/for_players/inform_about_payment.rst @@ -1,5 +1,5 @@ Как отметить факт сдачи взноса -==================================== +============================== Отмечая взнос в заявке, игрок оставляет информацию для мастера, который принял взнос, и для службы АХЧ, а также заметку «себе на будущее» на случай путаницы. Сдав взнос, зайдите в свою заявку и выберите «Отметить взнос». Через какое-то время мастера подтвердят, что всё ОК. diff --git a/docs/for_players/pay_online.rst b/docs/for_players/pay_online.rst index f1a537e..ea843db 100644 --- a/docs/for_players/pay_online.rst +++ b/docs/for_players/pay_online.rst @@ -1,7 +1,7 @@ Как оплатить взнос через JoinRPG онлайн ============================================ -Функция онлайн-оплаты доступна только в том случае, если игра или конвент `подключены к функционалу онлайн-оплаты `_. +Функция онлайн-оплаты доступна только в том случае, если игра или конвент `подключены к функционалу онлайн-оплаты `_. Заявка ----------- diff --git a/docs/groups/creating-group.rst b/docs/groups/creating-group.rst index a17ed4f..c0f1ed5 100644 --- a/docs/groups/creating-group.rst +++ b/docs/groups/creating-group.rst @@ -5,7 +5,7 @@ Вы можете это делать как на этапе проектирования сетки ролей, так и в процессе работы над игрой. -.. note:: В некоторых случаях будет удобнее пользоваться `специальными группами `_, создающимися автоматически при заполнении полей персонажа. +.. note:: В некоторых случаях будет удобнее пользоваться `специальными группами `_, создающимися автоматически при заполнении полей персонажа. **Меню → Сетка ролей → Группа → Добавить → ...подгруппу** diff --git a/docs/groups/notifications.rst b/docs/groups/notifications.rst index f5d6446..0c5ebd8 100644 --- a/docs/groups/notifications.rst +++ b/docs/groups/notifications.rst @@ -2,7 +2,7 @@ ====================== Уведомления о новых комментариях в заявках, где вы назначены ответственным мастером, будут всегда приходить вне зависимости от ваших настроек. Но вы можете подписаться на уведомления для любого числа групп. Если вы хотите получать вообще все уведомления проекта - подпишитесь на группу «Все роли». -Если вас интересует разрозненные персонажи - объедините их в `скрытую группу `_ и подпишитесь на нее либо подпишитесь на каждого персонажа в отдельности. +Если вас интересует разрозненные персонажи - объедините их в `скрытую группу `_ и подпишитесь на нее либо подпишитесь на каждого персонажа в отдельности. Подписка на группу ------------------- diff --git a/docs/groups/other.rst b/docs/groups/other.rst index 2ec1eb3..ae00b0c 100644 --- a/docs/groups/other.rst +++ b/docs/groups/other.rst @@ -39,7 +39,7 @@ Сюжеты ------- Сюжеты создаются в отдельной ветке «сюжеты» и любую из имеющихся групп можно на них подписать. -Подробней смотрите главу `«Сюжеты» `_. +Подробней смотрите главу `«Сюжеты» `_. Поля заявки ------------ diff --git a/docs/index.rst b/docs/index.rst index 152cf1c..032be5b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ JoinRPG Документация для JoinRPG. -Если вы хотите потестировать какую-то функцию или разобраться с функционалом — вам пригодится `тестовая среда `_. +Если вы хотите потестировать какую-то функцию или разобраться с функционалом — вам пригодится `тестовая среда `_. .. toctree:: :maxdepth: 3 diff --git a/docs/personal_data_policy/index.rst b/docs/personal_data_policy/index.rst index 0bbee10..0a93e13 100644 --- a/docs/personal_data_policy/index.rst +++ b/docs/personal_data_policy/index.rst @@ -1,5 +1,5 @@ Политика в отношении обработки персональных данных -========================= +================================================== `1. Общие положения`_ @@ -418,7 +418,7 @@ https://joinrpg.ru/game/create Пользователь (мастер/орган данных, как то предусмотрено п. 5.8 настоящей Политики. 8. Порядок сбора, хранения, передачи и других видов обработки персональных данных -------------------------------------------------------------------- +------------------------------------------------------------------------------------ Безопасность персональных данных, которые обрабатываются Оператором, обеспечивается путем реализации правовых, организационных и технических @@ -481,7 +481,7 @@ support@joinrpg.ru с пометкой «Актуализация персон данных, а также выявление неправомерной обработки персональных данных. 9. Перечень действий, производимых Оператором с полученными персональными данными -------------------------------------------------------------------- +------------------------------------------------------------------------------------ 9.1. Оператор осуществляет сбор, запись, систематизацию, накопление, хранение, уточнение (обновление, изменение), извлечение, использование, @@ -493,7 +493,7 @@ support@joinrpg.ru с пометкой «Актуализация персон по информационно-телекоммуникационным сетям или без таковой. 10. Трансграничная передача персональных данных -------------------------------------------------------------------- +----------------------------------------------- 10.1. Оператор до начала осуществления деятельности по трансграничной передаче персональных данных обязан уведомить уполномоченный орган diff --git a/docs/plot/creating-input.md b/docs/plot/creating-input.md deleted file mode 100644 index 3f8c30b..0000000 --- a/docs/plot/creating-input.md +++ /dev/null @@ -1,51 +0,0 @@ -# Создание вводной -Чтобы создать вводную, после создания сюжета на его странице нужно нажать «добавить вводную». -После добавления вводная будет доступна только для мастеров до тех пор, пока мастера ее не опубликуют. -Вводных в сюжете может быть сколько угодно. - -![Создание вводной](creating-input.png) - - -## Поля страницы вводной -На странице добавления вводной нужно заполнить поле **«текст вводной»**. Это обычно текстовое поле, в которое для выделения полужирным/курсивом или вставки ссылок и картинок может использоваться [разметка Markdown](http://commonmark.org/help). - -![Поля страницы вводной](attention.png) Советуем использовать для вводных подзаголовки, т.к. вводные автоматически получают название по первой строчке текста. Это удобно и для представления вводных для игроков: хотя для мастера все вводные персонажа разделены элементами управления, для игроков они представляются единым текстом. - -![Поля страницы вводной](attention.png) Загрузить картинку напрямую на сайт базы заявок не получится, но можно показать ее с помощью [разметки Markdown](http://commonmark.org/help) при условии, что она где-то выложена и вы знаете url. Обратите внимание, что картинка показывается «как есть», без возможности указать желаемую ширину. - - **Жирный текст** - *Текст курсивом* - ![альт текст для картинки](http://www.206368.mrsite.com/USERIMAGES/sample(1).jpg) - -**Поле «TODO»** соответствует аналогичному [полю у сюжетов](http://docs.joinrpg.ru/ru/latest/plot/creating-plot.html#todo). - -И, наконец, **поле «для кого»**. В это поле можно добавить как персонажей, так и группы персонажей, причем делать это сразу на этапе создания вводной не обязательно. Даже после ее публикации вводную можно будет расшарить новым добавленным персонажам (или группам). - -![Поля страницы вводной](input-add-form.png) - -После того как вводная добавлена, на странице сюжета она выглядить так: - -![Поля страницы вводной](input-added.png) - -## Статусы вводной -«Вводная в работе» - означает, что она не готова и не опубликована игрокам. -«Вводная закончена» - означает, что она готова и что проставленные в поле «для кого» игроки ее видят в своей заявке. - -![Статусы вводной](input-status.png) - -## Публикация вводной -Для того чтобы опубликовать вводную, надо: -1. Нажать на название вводной. -2. Выбрать «Изменить». - -![Публикация вводной](input-publication.png) - -3. Удостовериться что все пункты из TODO выполнены. -4. Поставить галочку в поле «готов». -5. Нажать «сохранить». - -![Публикация вводной](input-edit.png) - -С этого момента вводная приобрела статус «вводная закончена» и видна игрокам. - -Тем не менее, ее все еще можно редактировать, добавлять или удалять персонажей, которым эта вводная доступна. diff --git a/docs/plot/creating-input.rst b/docs/plot/creating-input.rst index a9797de..1c7d62f 100644 --- a/docs/plot/creating-input.rst +++ b/docs/plot/creating-input.rst @@ -1,5 +1,5 @@ Вводная -================ +======= Cоздание вводной ---------------------- @@ -19,11 +19,11 @@ Cоздание вводной ![альт текст для картинки](http://www.206368.mrsite.com/USERIMAGES/sample(1).jpg) -.. hint:: Советуем использовать для вводных подзаголовки, т.к. вводные автоматически получают название по первой строчке текста. Это удобно и для представления вводных для игроков: хотя для мастера все вводные персонажа разделены элементами управления, `для игроков они представляются единым текстом `_. +.. hint:: Советуем использовать для вводных подзаголовки, т.к. вводные автоматически получают название по первой строчке текста. Это удобно и для представления вводных для игроков: хотя для мастера все вводные персонажа разделены элементами управления, `для игроков они представляются единым текстом `_. .. attention:: Загрузить картинку напрямую на сайт базы заявок не получится, но можно показать ее с помощью `разметки Markdown `_ при условии, что она где-то выложена и вы знаете url. Обратите внимание, что картинка показывается «как есть», без возможности указать желаемую ширину. -**Поле «TODO»** соответствует аналогичному `полю у сюжетов `_. +**Поле «TODO»** соответствует аналогичному `полю у сюжетов `_. И, наконец, **поле «для кого»**. В это поле можно добавить как персонажей, так и группы персонажей, причем делать это сразу на этапе создания вводной не обязательно. Даже после ее публикации вводную можно будет расшарить новым добавленным персонажам (или группам). diff --git a/docs/plot/handout.rst b/docs/plot/handout.rst index 9166993..24770cc 100644 --- a/docs/plot/handout.rst +++ b/docs/plot/handout.rst @@ -5,7 +5,7 @@ Он предназначен для упрощения мастерского труда при формировании раздатки - конверт с физическими вещами, которые получает игрок на полигоне непосредственно перед игрой. Такими вещами могут быть: карточки болезни, игровые деньги, паспорт, браслет игрока, специфические вещи, заданные сюжетом и вводной. Раздел «элементы раздатки» концентрируется на последних, а о раздатках в общем можно почитать в соответствующем разделе *(будет позже)*. -Принцип добавления элементов раздатки `аналогичен вводным `_ - заполняем поля и нажимаем «добавить вводную». +Принцип добавления элементов раздатки `аналогичен вводным `_ - заполняем поля и нажимаем «добавить вводную». .. figure:: creationg-distribution.png :scale: 100 % diff --git a/docs/plot/index.rst b/docs/plot/index.rst index ba4dbc6..facbe25 100644 --- a/docs/plot/index.rst +++ b/docs/plot/index.rst @@ -8,7 +8,6 @@ .. toctree:: :maxdepth: 3 - creating-plot creating-input special handout diff --git a/docs/plot/other.rst b/docs/plot/other.rst index 114edf8..7f6b2f7 100644 --- a/docs/plot/other.rst +++ b/docs/plot/other.rst @@ -1,5 +1,5 @@ Дополнительные возможности -====== +========================== Сюжеты на странице группы -------------------------- Для того чтобы посмотреть все сюжеты, связанные с конкретной группой из сетки ролей, надо открыть группу и нажать на вкладку «сюжеты». @@ -19,7 +19,7 @@ :align: center :alt: Сюжеты со страницы группы -.. attention:: С этой страницы также можно `создавать сюжеты `_, но обратите внимание, что сюжеты и вводные, созданные с этой страницы, **не будут** автоматически привязаны к данной группе. +.. attention:: С этой страницы также можно `создавать сюжеты `_, но обратите внимание, что сюжеты и вводные, созданные с этой страницы, **не будут** автоматически привязаны к данной группе. Вводные на странице персонажа ------------------------------ diff --git a/docs/plot/special.rst b/docs/plot/special.rst index 4880caf..fc217f4 100644 --- a/docs/plot/special.rst +++ b/docs/plot/special.rst @@ -1,5 +1,5 @@ Контакты игроков и ссылки на роли -==================== +================================= Во вводных работают **специальные символы**. Они облегчают работу мастера по обмену контактами связанных друг с другом игроков и оформление ссылок на персонажей и группы из сетки ролей. При обновлении данных в сетке ролей (редактировании названия / смене игрока на роли и т.п.) вводная, в которой используются специальные символы в динамическом варианте, обновится автоматически. @@ -94,7 +94,7 @@ .. attention:: В том случае, если для какого-либо персонажа из группы выбрана опция «скрывать игрока», при использовании специальных символов его имя и контакты будут показаны все равно. -.. hint:: Показывать контакты можно для любой группы: не только общедоступной из сетки ролей, но также `специальной `_ и/или `скрытой `_ группы +.. hint:: Показывать контакты можно для любой группы: не только общедоступной из сетки ролей, но также `специальной `_ и/или `скрытой `_ группы Часть сетки ролей с контактами ------------------------------------ diff --git a/docs/project/access.rst b/docs/project/access.rst index 3a2a5bd..519fa23 100644 --- a/docs/project/access.rst +++ b/docs/project/access.rst @@ -1,5 +1,5 @@ Доступ в проект -============= +=============== .. attention:: Все мастера проекта всегда показываются на его домашней странице, а также в профиле пользователя видно, какие проекты он администрирует и/или создал. Добавление нового мастера @@ -24,7 +24,7 @@ Доступ к тем или иным разделам может быть проставлен в любой комбинации. В том случае, если у мастера не стоит никаких дополнительных прав, он может писать комментарии в заявках и видеть любые мастерские материалы в базе. * Администратор заявок — может изменять статус заявок (принимать, отклонять, переносить в лист ожидания) и переназначать ответственного мастера для любой заявки в базе -* Настраивать поля персонажа — может добавлять, удалять или редактировать `поля заявки и поля персонажа `_. +* Настраивать поля персонажа — может добавлять, удалять или редактировать `поля заявки и поля персонажа `_. * Настраивать проект — может изменять свойства проекта, переименовывать его, отправлять проект в архив и т.д. * Давать доступ другим мастерам — может добавлять или удалять пользователей, настраивать права доступа. * Редактировать ролевку — может добавлять новые группы или новых персонажей, редактировать и удалять группы и персонажей. diff --git a/docs/project/after.rst b/docs/project/after.rst index c4f9485..9ca7194 100644 --- a/docs/project/after.rst +++ b/docs/project/after.rst @@ -1,5 +1,5 @@ После игры -============= +========== При выборе «Закрыть проект» в свойствах проекта база заявок *переносится в архив*. Закрытый проект не будет доступен в списке игр, на него нельзя будет больше заявиться или что-либо отредактировать. Для просмотра он останется по прямой ссылке или в `архиве игр `_ точно в таком состоянии, как его закрыли. .. attention:: Закрытые проекты нельзя открыть снова. @@ -14,7 +14,7 @@ **Остаются скрыты от всех, кроме имеющих доступ к проекту / конкретной заявке**: переписка по поводу роли между игроком и мастерами, неопубликованные вводные, пометки «TODO» в сюжетах и вводных (даже если вводная опубликована), поля персонажа и заявки, если до закрытия проекта они не были публичными. Автоматическое закрытие проекта ---------------------- +------------------------------- Если в течение полугода в проекте не было никакой активности (не оставлялись комментарии к заявкам, не редактировались персонажи в сетке ролей и т.п.), он будет перенесен в архив автоматически через месяц. мастера получат письмо с предупреждением. .. hint:: Если вам нужно оставить проект в актуальных — достаточно что-то любое поменять в проекте, оставить комментарий, изменить поля персонажа и т.п. diff --git a/docs/project/new_project.rst b/docs/project/new_project.rst index ec486d5..bb98af0 100644 --- a/docs/project/new_project.rst +++ b/docs/project/new_project.rst @@ -1,6 +1,6 @@ Создание нового проекта -==================== -Для создания новой базы заявок необходим аккаунт пользователя joinrpg. Если у вас его нет — то `зарегистрироваться просто `_ (например, возможна регистрация со своим аккаунтом вконтакте или google-аккаунтом). +======================= +Для создания новой базы заявок необходим аккаунт пользователя joinrpg. Если у вас его нет — то `зарегистрироваться просто `_ (например, возможна регистрация со своим аккаунтом вконтакте или google-аккаунтом). .. figure:: create_new.png :scale: 100 % @@ -12,15 +12,15 @@ Для проектов предусмотрены **три шаблона настроек** (выбираются при создании базы заявок): 1. **Ролевая игра**. Автопринятие заявок и система проживания отключены, опция «Проверять, что игрок играет только одного персонажа» включена. В списке полей заявки / персонажа есть автоматически созданные поля «Имя персонажа» и «Описание персонажа». -2. ** Конвент**. Заявки участников будут приниматься автоматически, «имя персонажа» формироваться из имени игрока в его профиле. Опция «Проверять, что игрок играет только одного персонажа» включена, `система проживания `_ включена. +2. ** Конвент**. Заявки участников будут приниматься автоматически, «имя персонажа» формироваться из имени игрока в его профиле. Опция «Проверять, что игрок играет только одного персонажа» включена, `система проживания `_ включена. 3. **Конвент: мероприятия**. -Все настройки, проставленные в рамках шаблона, могут быть изменены. О том, как можно редактировать поля заявки / персонажа, подробнее рассказано в `соответствующем разделе документации `_. +Все настройки, проставленные в рамках шаблона, могут быть изменены. О том, как можно редактировать поля заявки / персонажа, подробнее рассказано в `соответствующем разделе документации `_. -`Закрывайте проект `_ после завершения игры, чтобы список игр на главной странице сайта был актуальным. +`Закрывайте проект `_ после завершения игры, чтобы список игр на главной странице сайта был актуальным. Правила использования joinrpg для ваших проектов ---------------------------------------------------- +------------------------------------------------ 1. Joinrpg — для ролевых игр. Если ваше мероприятие не является ролевой игрой или ролевым конвентом, просьба согласовать возможность использования joinrpg отдельно по адресу support@joinrpg.ru 2. Надеемся, что вам понравится наш сайт. Мы сами мастера и делаем его для других мастеров. Ведите себя адекватно, используйте сайт по назначению и все будет здорово. @@ -32,7 +32,7 @@ 8. Рады вас видеть и удачной вам игры! Свойства проекта -------------------------- +---------------- **Меню > Прочее > Свойства проекта** .. figure:: project_settings.png @@ -51,4 +51,4 @@ * При активной опции «Проверять, что игрок играет только одного персонажа» при принятии одной из заявок игрока, подавшего больше одной заявки, все остальные заявки этого игрока на другие роли будут автоматически отклонены. -О том, как **закрыть проект**, подробнее сказано в разделе `«После игры» `_. +О том, как **закрыть проект**, подробнее сказано в разделе `«После игры» `_. diff --git a/docs/project/testing.rst b/docs/project/testing.rst index 24404a3..c40ffeb 100644 --- a/docs/project/testing.rst +++ b/docs/project/testing.rst @@ -1,5 +1,5 @@ Тестовая среда -============= +============== Если вы еще не знакомы с системой или хотели бы протестировать какие-то возможности до создания базы заявок своей игры, то рекомендуем для этого тестовую версию сайта `dev.joinrpg.ru `_. .. attention:: Перенос проекта с тестовой среды на действующий сайт невозможен. Используйте dev.joinrpg.ru только для экспериментов. diff --git a/docs/register/index.rst b/docs/register/index.rst index 327a41b..69d8bf8 100644 --- a/docs/register/index.rst +++ b/docs/register/index.rst @@ -1,5 +1,5 @@ Регистрация на JoinRPG -==================== +====================== 1. Мы рады видеть вас на нашем сайте! Надеемся, что ваш опыт на джойне как игрока, и как мастера будет приятным. Ведите себя прилично и вежливо, и все будет хорошо. 2. Если у вас будут какие-то проблемы, пишите в поддержку ( support@joinrpg.ru / ). Мы всегда рады помочь, но обратите внимание: вы ничего не платите нам, и, следовательно, не являетесь нашим клиентом. Мы поддерживаем сайт бесплатно и в свободное время, у нас есть работа, семья, личная жизнь, другие хобби. @@ -11,7 +11,7 @@ 8. Рады вас видеть и удачных вам игр! Новый аккаунт ---------------------- +------------- Вы можете: * создать новый аккаунт с вашим емейлом `на странице регистрации `_; @@ -20,7 +20,7 @@ .. hint:: При регистрации (и в любой момент позднее) вы можете установить видимость своих социальных сетей другим пользователям `в поле «Публичность соцсетей» вашего профиля `_. Импорт аккаунта allrpg -------------------------------- +---------------------- В настоящий момент не поддерживается. @@ -31,7 +31,7 @@ .. Если ваша почта, указанная для allrpg, совпадает с почтой профиля Вконтакте / Google-аккаунта, то при входе с использованием социальных сетей профиль с allrpg тоже будет автоматически импортирован. Загрузка аватарки из Вконтакте -------------------------- +------------------------------ Произойдет автоматически при первом логине через эту социальную сеть. Если вы уже использовали настроенную аватарку из Gravatar — в `настройках вашего профиля `_ потребуется переключить на новую аватарку из ВКонтакте. @@ -39,7 +39,7 @@ Если вы обновляли аватарку во Вконтакте и хотите обновить ее на joinrpg — также в `настройках вашего профиля `_ нажмите «Перекешировать», чтобы подтянуть новую аватарку. Загрузка аватарки в Gravatar -------------------------- +---------------------------- Для того чтобы загрузить свой аватар, необходимо выполнить следующую последовательность действий: Зайти на `gravatar.com `_ (кнопка “Войти” в правом верхнем углу окна). diff --git a/docs/schedule/add_to_calendar.rst b/docs/schedule/add_to_calendar.rst index 274871f..d007d9e 100644 --- a/docs/schedule/add_to_calendar.rst +++ b/docs/schedule/add_to_calendar.rst @@ -1,4 +1,4 @@ Как добавить расписание мероприятий в календарь -============================================ +=============================================== Перейдите на страницу Расписание. Там будет ссылка на календарь в формате `.ics`. Скопируйте эту ссылку и введите в вашу любимую программу календарей. diff --git a/docs/schedule/index.rst b/docs/schedule/index.rst index 65df30f..9ea1776 100644 --- a/docs/schedule/index.rst +++ b/docs/schedule/index.rst @@ -1,5 +1,5 @@ Мероприятие и расписание -======= +======================== В joinrpg.ru есть поддержка ведения базы заявок мероприятий на конвенты. Ведущие могут подавать заявки через joinrpg.ru, организаторы настраивать таймслоты и место проведения, а также составлять расписание. @@ -11,7 +11,7 @@ add_to_calendar Как настроить ------------ +------------- Подробная инструкция будет позже. 1. Нужно создать базу заявок типа «Конвент-мероприятие» @@ -20,7 +20,7 @@ 4. Мероприятия появятся в расписании, если принять заявку и установить им время и место «Расписание конвентов» -------- +---------------------- При желании можно настроить импорт в приложение «`Расписание конвентов `_». Для этого обратитесь к его авторам. Обратите внимание, что это приложение является **платным** для организаторов конвентов.