From 8674bd7beba70a89cefde6ad8a3bc95e38589bbd Mon Sep 17 00:00:00 2001 From: IRBorisov <8611739+IRBorisov@users.noreply.github.com> Date: Tue, 7 May 2024 17:58:36 +0300 Subject: [PATCH] Update help pages --- .vscode/settings.json | 1 + .../src/components/man/HelpConstituenta.tsx | 39 ++++++++++++------- .../src/components/man/HelpCstAttributes.tsx | 16 ++++---- .../src/components/man/HelpExteor.tsx | 1 + .../src/components/man/HelpLibrary.tsx | 13 ++----- .../frontend/src/components/man/HelpMain.tsx | 9 +++-- .../src/components/man/HelpRSFormItems.tsx | 28 ++++++++----- .../src/components/man/HelpRSFormMeta.tsx | 24 ++++++++---- .../src/components/man/HelpRSLang.tsx | 11 +++--- .../src/components/man/HelpTermGraph.tsx | 20 +++++----- .../components/man/HelpTerminologyControl.tsx | 6 +-- .../frontend/src/context/UsersContext.tsx | 2 +- .../frontend/src/models/miscellaneous.ts | 2 +- rsconcept/frontend/src/pages/NotFoundPage.tsx | 2 +- rsconcept/frontend/src/styling/color.ts | 4 +- rsconcept/frontend/src/styling/setup.css | 4 ++ rsconcept/frontend/src/styling/styles.css | 9 +++++ rsconcept/frontend/src/utils/labels.ts | 4 +- 18 files changed, 116 insertions(+), 79 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index e6796bdb..4647d123 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -140,6 +140,7 @@ "Родоструктурная", "Родоструктурное", "родоструктурной", + "родоструктурном", "Синглетон", "твор", "Терминологизация", diff --git a/rsconcept/frontend/src/components/man/HelpConstituenta.tsx b/rsconcept/frontend/src/components/man/HelpConstituenta.tsx index 89437114..e343c917 100644 --- a/rsconcept/frontend/src/components/man/HelpConstituenta.tsx +++ b/rsconcept/frontend/src/components/man/HelpConstituenta.tsx @@ -1,23 +1,36 @@ import InfoCstStatus from '@/components/info/InfoCstStatus'; import Divider from '@/components/ui/Divider'; +import { useConceptOptions } from '@/context/OptionsContext'; + +import { IconControls, IconEdit, IconList, IconSave, IconStatusOK, IconText, IconTree } from '../Icons'; function HelpConstituenta() { + const { colors } = useConceptOptions(); // prettier-ignore return (
-

Редактор конституент

-

Помимо активной конституенты выделяются порожденные и основание

-

Сохранить изменения: Ctrl + S или клик по кнопке Сохранить

-

Формальное определение

-

- Ctrl + Пробел дополняет до незанятого имени

-

- специальные конструкции вводятся с помощью кнопок снизу

-

Термин и Определение

-

- Ctrl + Пробел открывает редактирование отсылок

-

Список конституент

-

- первая настройка - атрибуты конституенты

-

- вторая настройка - отбор по графу термов

-

- текущая конституента выделена цветом строки

-

- при наведении на имя конституенты отображаются атрибуты

+

Редактор конституенты

+
  • сохранить изменения: Ctrl + S
    • +
  • кнопка переименования справа от Имени
    • + +

    Термин и Текстовое определение

    +
  • кнопка редактирования словоформ справа от Термина
    • +
  • Ctrl + Пробел открывает редактирование отсылок
    • + +

    Определение понятия

    +
  • индикатор статуса определения сверху
    • +
  • переключение шрифта
    • +
  • специальная клавиатура и горячие клавиши
    • +
  • отображение списка конституент
    • +
  • отображение дерева разбора
    • +
  • Ctrl + Пробел дополняет до незанятого имени
    • + +

    Список конституент

    +
  • фильтрация в верхней части
    • +
  • при наведении на имя конституенты отображаются атрибуты
    • +
  • цветом фона выделена текущая конституента
    • +
  • цветом фона выделена основа текущей
    • +
  • цветом фона выделены порожденные текущей
    • diff --git a/rsconcept/frontend/src/components/man/HelpCstAttributes.tsx b/rsconcept/frontend/src/components/man/HelpCstAttributes.tsx index ed51efda..0ce39a66 100644 --- a/rsconcept/frontend/src/components/man/HelpCstAttributes.tsx +++ b/rsconcept/frontend/src/components/man/HelpCstAttributes.tsx @@ -1,3 +1,4 @@ +import { urls } from '@/app/urls'; import { HelpTopic } from '@/models/miscellaneous'; import TextURL from '../ui/TextURL'; @@ -8,22 +9,21 @@ function HelpCstAttributes() {

    Аттрибуты конституенты

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

    -

    Формальное определение строится с помощью формального аппарата

    +

    Формальное определение строится с помощью формального аппарата

    Типизация вычисляется автоматически на основе Формального определения и отражает структуру элементов множества, задаваемого этим определением

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

    -

    Конвенция - это соглашение о соотнесении неопределенного понятия с сущностями в предметной области

    +

    Конвенция – это соглашение о соотнесении неопределенного понятия с сущностями в предметной области

    Комментарий может быть добавлен к любому производному понятию для хранения дополнительной информации

    Неопределяемые понятия

    -

    X1, C1 - Базисные множества и Константные множества не обладают сложной структурой и определяются Конвенцией. Элементы Константных множеств участвуют в арифметических операциях и порядковых предикатах наряду с мощностями множеств

    -

    S1 :∈ ℬ(X1) - Родовые структуры задаются совокупностью Области определения, Конвенции и набора Аксиом, а также Термином. Согласно Конвенции элементы родовой структуры заполняются из Области определения так, чтобы Аксиомы были выполнены. Родовая структура может быть как множеством, так и элементом или кортежем

    -

    A1 :== ∀(α,β)∈S1 (β,α)∈S1 - Аксиомы задаются логическим Формальным определением и по необходимости Конвенцией

    +

    X1, C1 – Базисные множества и Константные множества не обладают сложной структурой и определяются Конвенцией. Элементы Константных множеств участвуют в арифметических операциях и порядковых предикатах наряду с мощностями множеств

    +

    S1 :∈ ℬ(X1) – Родовые структуры задаются совокупностью Области определения, Конвенции и набора Аксиом, а также Термином. Согласно Конвенции элементы родовой структуры заполняются из Области определения так, чтобы Аксиомы были выполнены. Родовая структура может быть как множеством, так и элементом или кортежем

    +

    A1 :== ∀(α,β)∈S1 (β,α)∈S1 – Аксиомы задаются логическим Формальным определением и по необходимости Конвенцией

    Производные понятия

    -

    D1 :== Pr1(S1) - Термы задаются типизированным Формальным определением

    -

    T1 :== Pr1(S1)=Pr2(S1) - Теоремы определяются логическим Формальным определением

    +

    D1 :== Pr1(S1) – Термы задаются типизированным Формальным определением

    +

    T1 :== Pr1(S1)=Pr2(S1) – Теоремы определяются логическим Формальным определением

    F1 :== [σ∈ℬ(X1×X1)] Pr1(σ)\Pr2(σ)
    Терм-функции определяются параметризованным типизированным Формальным определением

    P1 :== [σ∈ℬ(X1×X1)] card(Pr1(σ)) = card(σ)
    Предикат-функции определяются параметризованным логическим Формальным определением

    -
    ); } diff --git a/rsconcept/frontend/src/components/man/HelpExteor.tsx b/rsconcept/frontend/src/components/man/HelpExteor.tsx index bcdb2b60..af16df99 100644 --- a/rsconcept/frontend/src/components/man/HelpExteor.tsx +++ b/rsconcept/frontend/src/components/man/HelpExteor.tsx @@ -10,6 +10,7 @@ function HelpExteor() {

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

    Экстеор доступен на операционной системы Windows 10+

    Скачать установщик: |

    +

    Основные функции

  • Работа с РС-формой системы понятий
  • Автоматическое определение типизации выражений
    • diff --git a/rsconcept/frontend/src/components/man/HelpLibrary.tsx b/rsconcept/frontend/src/components/man/HelpLibrary.tsx index 7c48d717..f01d8477 100644 --- a/rsconcept/frontend/src/components/man/HelpLibrary.tsx +++ b/rsconcept/frontend/src/components/man/HelpLibrary.tsx @@ -3,21 +3,16 @@ import { IconImmutable, IconPublic } from '../Icons'; function HelpLibrary() { // prettier-ignore return ( -
    +

    Библиотека схем

    В библиотеке собраны концептуальные схемы, эксплицированные в родоструктурном аппарате

    используемые при концептуального проектирования систем организационного управления

    Фильтрация с помощью инструментов в верхней части страницы

    Сортировка по клику на заголовок таблицы

    +

    Отображение статусов

    -
    - -

    общедоступная отображает схему всем пользователям

    -
    -
    - -

    неизменная выделяет стандартные схемы

    -
    +

    - общедоступная отображает схему всем пользователям

    +

    - неизменная выделяет стандартные схемы

    ); } diff --git a/rsconcept/frontend/src/components/man/HelpMain.tsx b/rsconcept/frontend/src/components/man/HelpMain.tsx index 875da8a9..18a0dc3f 100644 --- a/rsconcept/frontend/src/components/man/HelpMain.tsx +++ b/rsconcept/frontend/src/components/man/HelpMain.tsx @@ -8,13 +8,14 @@ function HelpMain() { return (

    Портал

    -

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

    +

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

    +

    Такие системы называются Концептуальными схемами и состоят из отдельных , обладающих уникальными обозначениями и формальными определениями


    Основные разделы

    -
  • - библиотека концептуальных схем
    • -
  • - справочные материалы
    • -
  • - данные пользователя и смена пароля
    • +
  • – библиотека концептуальных схем
    • +
  • – справочные материалы
    • +
  • – данные пользователя и смена пароля

    • Навигация и настройки

    diff --git a/rsconcept/frontend/src/components/man/HelpRSFormItems.tsx b/rsconcept/frontend/src/components/man/HelpRSFormItems.tsx index a0970824..71a5639a 100644 --- a/rsconcept/frontend/src/components/man/HelpRSFormItems.tsx +++ b/rsconcept/frontend/src/components/man/HelpRSFormItems.tsx @@ -1,22 +1,30 @@ +import { urls } from '@/app/urls'; import InfoCstStatus from '@/components/info/InfoCstStatus'; import Divider from '@/components/ui/Divider'; +import { HelpTopic } from '@/models/miscellaneous'; + +import { IconAlias, IconMoveDown, IconMoveUp } from '../Icons'; +import TextURL from '../ui/TextURL'; function HelpRSFormItems() { // prettier-ignore return (

    Список конституент

    -

    Конституенты обладают уникальным Именем, включающим их тип

    -

    Список поддерживает выделение и перемещение

    +

    Конституенты обладают уникальным

    +

    Список поддерживает выделение и перемещение

    +

    Управление списком

    -

    Клик на строку - выделение

    -

    Shift + клик - выделение нескольких

    -

    Alt + клик - Редактор

    -

    Двойной клик - Редактор

    -

    Alt + вверх/вниз - перемещение

    -

    Delete - удаление

    -

    Alt + 1-6,Q,W - добавление

    - +
  • Клик на строку – выделение
    • +
  • Shift + клик – выделение нескольких
    • +
  • Alt + клик – Редактор
    • +
  • Двойной клик – Редактор
    • +
  • Alt + вверх/вниз – перемещение
    • +
  • Delete – удаление
    • +
  • Alt + 1-6,Q,W – добавление
    • + + +
    ); } diff --git a/rsconcept/frontend/src/components/man/HelpRSFormMeta.tsx b/rsconcept/frontend/src/components/man/HelpRSFormMeta.tsx index f091a8b7..8843ab95 100644 --- a/rsconcept/frontend/src/components/man/HelpRSFormMeta.tsx +++ b/rsconcept/frontend/src/components/man/HelpRSFormMeta.tsx @@ -1,18 +1,26 @@ +import { urls } from '@/app/urls'; +import { HelpTopic } from '@/models/miscellaneous'; + +import { IconClone, IconDownload, IconFollow, IconImmutable, IconOwner, IconPublic, IconSave } from '../Icons'; +import TextURL from '../ui/TextURL'; + function HelpRSFormMeta() { // prettier-ignore return (

    Карточка схемы

    -

    Концептуальная схема содержит конституенты, формирующие систему терминов и определений

    +

    Карточка схемы содержит общую информацию и статистику схемы

    +

    Карточка схемы позволяет управлять атрибутами схемы и ее

    +

    Управление

    -

    Сохранить изменения: Ctrl + S или кнопка Сохранить

    -

    Владелец обладает правом редактирования

    -

    Общедоступные схемы доступны для всех

    -

    Неизменные схемы редактируют только администраторы

    -

    Клонировать - создать копию схемы под своим именем

    -

    Отслеживание - схема в персональном списке

    -

    Загрузить/Выгрузить схему - взаимодействие с Экстеор

    +
  • сохранить изменения: Ctrl + S
    • +
  • Владелец обладает правом редактирования
    • +
  • Общедоступные схемы доступны для всех
    • +
  • Неизменные схемы редактируют только администраторы
    • +
  • Клонировать – создать копию схемы
    • +
  • Отслеживание – схема в персональном списке
    • +
  • Загрузить/Выгрузить схему – взаимодействие с Экстеор
    • ); } diff --git a/rsconcept/frontend/src/components/man/HelpRSLang.tsx b/rsconcept/frontend/src/components/man/HelpRSLang.tsx index 27eef03f..a4845136 100644 --- a/rsconcept/frontend/src/components/man/HelpRSLang.tsx +++ b/rsconcept/frontend/src/components/man/HelpRSLang.tsx @@ -17,16 +17,15 @@ function HelpRSLang() { // prettier-ignore return (
    -
    +

    Родоструктурная экспликация концептуальных схем

    Формальная запись (экспликация) концептуальных схем осуществляется с помощью языка родов структур.

    Данный математический аппарат основан на аксиоматической теории множеств Цермелло-Френкеля и аппарате родов структур Н.Бурбаки.

    +

    Для ознакомления с основами родов структур можно использовать следующие материалы:

    - +

    1. Видео: Краткое введение в мат. аппарат

    +

    2. Текст: Учебник И. Н. Пономарева

    +

    3. Видео: лекции для 4 курса (второй семестр 2022-23 год)

    Настройка графа

    -

    Цвет - выбор правила покраски узлов

    -

    Граф - выбор модели расположения узлов

    -

    Удалить несвязанные - скрыть одинокие вершины

    -

    Транзитивная редукция - скрыть транзитивные пути

    +

    Цвет – правила покраски узлов

    +

    Граф – модель расположения узлов

    +

    Размер – модель размера узлов

    - +
    @@ -21,13 +20,12 @@ function HelpTermGraph() {
    -

    Клавиши

    -

    Клик на конституенту - выделение

    -

    Двойной клик - редактирование

    -

    Delete - удалить выбранные

    -
    +

    Управление

    +

    Клик на конституенту – выделение

    +

    Двойной клик – редактирование

    +

    Delete – удалить выбранные

    - +
    diff --git a/rsconcept/frontend/src/components/man/HelpTerminologyControl.tsx b/rsconcept/frontend/src/components/man/HelpTerminologyControl.tsx index d56cf2c7..11c645ea 100644 --- a/rsconcept/frontend/src/components/man/HelpTerminologyControl.tsx +++ b/rsconcept/frontend/src/components/man/HelpTerminologyControl.tsx @@ -6,9 +6,9 @@ function HelpTerminologyControl() {

    Портал позволяет контролировать употребление терминов, привязанных к сущностям в концептуальных схемах.

    Для этого используется механизм текстовых отсылок: использование термина и связывание слов.

    При отсылке к термину указывается параметры словоформы так, обеспечивающие корректное согласование слов.

    -

    Граммема - минимальная единица грамматической информами, например род, число, падеж.

    -

    Словоформа - грамматическая форма словосочетания, которая может меняться в зависимости от его грамматических характеристик.

    -

    Лексема - все грамматические формы и словосочетания, связанные с данным словосочетанием.

    +

    Граммема – минимальная единица грамматической информами, например род, число, падеж.

    +

    Словоформа – грамматическая форма словосочетания, которая может меняться в зависимости от его грамматических характеристик.

    +

    Лексема – все грамматические формы и словосочетания, связанные с данным словосочетанием.

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

    ); } diff --git a/rsconcept/frontend/src/context/UsersContext.tsx b/rsconcept/frontend/src/context/UsersContext.tsx index d430dd6b..736de198 100644 --- a/rsconcept/frontend/src/context/UsersContext.tsx +++ b/rsconcept/frontend/src/context/UsersContext.tsx @@ -2,8 +2,8 @@ import { createContext, useCallback, useContext, useEffect, useState } from 'react'; -import { type IUserInfo } from '@/models/library'; import { getActiveUsers } from '@/app/backendAPI'; +import { type IUserInfo } from '@/models/library'; interface IUsersContext { users: IUserInfo[]; diff --git a/rsconcept/frontend/src/models/miscellaneous.ts b/rsconcept/frontend/src/models/miscellaneous.ts index 306b4ceb..4289dc12 100644 --- a/rsconcept/frontend/src/models/miscellaneous.ts +++ b/rsconcept/frontend/src/models/miscellaneous.ts @@ -45,12 +45,12 @@ export enum HelpTopic { MAIN = 'main', LIBRARY = 'library', RSFORM = 'rsform', - CST_ATTRIBUTES = 'cst-type', CST_LIST = 'cst-list', CST_EDITOR = 'cst-editor', GRAPH_TERM = 'graph-term', RSTEMPLATES = 'rstemplates', RSLANG = 'rslang', + CST_ATTRIBUTES = 'cst-type', TERM_CONTROL = 'terminology-control', VERSIONS = 'versions', EXTEOR = 'exteor', diff --git a/rsconcept/frontend/src/pages/NotFoundPage.tsx b/rsconcept/frontend/src/pages/NotFoundPage.tsx index 146c8bc4..0a466a92 100644 --- a/rsconcept/frontend/src/pages/NotFoundPage.tsx +++ b/rsconcept/frontend/src/pages/NotFoundPage.tsx @@ -3,7 +3,7 @@ import TextURL from '@/components/ui/TextURL'; export function NotFoundPage() { return (
    -

    Ошибка 404 - Страница не найдена

    +

    Ошибка 404 – Страница не найдена

    Данная страница не существует или запрашиваемый объект отсутствует в базе данных

    diff --git a/rsconcept/frontend/src/styling/color.ts b/rsconcept/frontend/src/styling/color.ts index 858f0c07..4203577e 100644 --- a/rsconcept/frontend/src/styling/color.ts +++ b/rsconcept/frontend/src/styling/color.ts @@ -76,7 +76,7 @@ export const lightT: IColorTheme = { bgOrange: 'hsl(028, 100%, 075%)', bgGreen50: 'hsl(100, 100%, 090%)', - bgOrange50: 'hsl(028, 100%, 095%)', + bgOrange50: 'hsl(028, 100%, 090%)', fgRed: 'hsl(000, 090%, 045%)', fgGreen: 'hsl(100, 090%, 035%)', @@ -116,7 +116,7 @@ export const darkT: IColorTheme = { bgOrange: 'hsl(035, 100%, 035%)', bgGreen50: 'hsl(100, 080%, 017%)', - bgOrange50: 'hsl(035, 100%, 015%)', + bgOrange50: 'hsl(035, 100%, 016%)', fgRed: 'hsl(000, 080%, 045%)', fgGreen: 'hsl(100, 080%, 035%)', diff --git a/rsconcept/frontend/src/styling/setup.css b/rsconcept/frontend/src/styling/setup.css index 601ac355..db41cb5d 100644 --- a/rsconcept/frontend/src/styling/setup.css +++ b/rsconcept/frontend/src/styling/setup.css @@ -123,6 +123,10 @@ div:not(.dense) > p { @apply font-semibold; } + li::marker { + content: '– '; + } + .border { @apply rounded; } diff --git a/rsconcept/frontend/src/styling/styles.css b/rsconcept/frontend/src/styling/styles.css index a0776362..80e615dc 100644 --- a/rsconcept/frontend/src/styling/styles.css +++ b/rsconcept/frontend/src/styling/styles.css @@ -195,6 +195,15 @@ } } + .inline-icon { + display: inline-block; + font-size: 1.25rem; + margin-left: 0.1rem; + margin-right: 0.1rem; + transform: translate(0, -0.2rem); + @apply clr-text-primary; + } + .cc-modal-blur { opacity: 0.3; backdrop-filter: blur(2px); diff --git a/rsconcept/frontend/src/utils/labels.ts b/rsconcept/frontend/src/utils/labels.ts index 62f683ca..2eadd2d6 100644 --- a/rsconcept/frontend/src/utils/labels.ts +++ b/rsconcept/frontend/src/utils/labels.ts @@ -361,12 +361,12 @@ export function labelHelpTopic(topic: HelpTopic): string { case HelpTopic.MAIN: return 'Портал'; case HelpTopic.LIBRARY: return 'Библиотека'; case HelpTopic.RSFORM: return '- карточка схемы'; - case HelpTopic.CST_ATTRIBUTES: return '- конституента'; case HelpTopic.CST_LIST: return '- список конституент'; case HelpTopic.CST_EDITOR: return '- редактор конституенты'; case HelpTopic.GRAPH_TERM: return '- граф термов'; case HelpTopic.RSTEMPLATES: return '- шаблоны выражений'; case HelpTopic.RSLANG: return 'Экспликация'; + case HelpTopic.CST_ATTRIBUTES: return '- конституента'; case HelpTopic.TERM_CONTROL: return 'Терминологизация'; case HelpTopic.VERSIONS: return 'Версионирование'; case HelpTopic.EXTEOR: return 'Экстеор'; @@ -384,12 +384,12 @@ export function describeHelpTopic(topic: HelpTopic): string { case HelpTopic.MAIN: return 'Общая справка по порталу'; case HelpTopic.LIBRARY: return 'Описание работы с библиотекой схем'; case HelpTopic.RSFORM: return 'Описание работы с описанием схемы'; - case HelpTopic.CST_ATTRIBUTES: return 'Описание типов и свойств конституент'; case HelpTopic.CST_LIST: return 'Описание работы со списком конституент'; case HelpTopic.CST_EDITOR: return 'Описание редактирования конституенты'; case HelpTopic.GRAPH_TERM: return 'Описание работы с графом термов схемы'; case HelpTopic.RSTEMPLATES: return 'Описание работы с Банком выражений>'; case HelpTopic.RSLANG: return 'Справка по языку родов структур и экспликации'; + case HelpTopic.CST_ATTRIBUTES: return 'Описание типов и свойств конституент'; case HelpTopic.TERM_CONTROL: return 'Справка по контролю терминов и текстовым отсылкам'; case HelpTopic.VERSIONS: return 'Справка по управлению версиями схем'; case HelpTopic.EXTEOR: return 'Справка по программе для экспликации "Экстеор" для Windows';