Синтаксис языка разметки документов Markdown

Внимание

Оформление элементов разметки, представленных на этой странице, может отличаться от оформления в документах OSA.

Аббревиатуры и сокращения

Исходный текст

Будут выделены и снабжены подсказками все аббревиатуры "HTML"
в тексте документа.

*[HTML]: Hyper Text Markup Language (язык разметки гипертекста)

Цитаты

Исходный текст

> Это цитата
> со встроенным кодом `код` и ссылкой [link](https://tas-project.ru)

> Цитаты могут быть вложенными...
>
> > ...просто используйте несколько знаков ">"...
> >
> > > ...можно и с пробелами.

Результат

Это цитата со встроенным кодом код и ссылкой link

Цитаты могут быть вложенными...

...просто используйте несколько знаков ">"...

...можно и с пробелами.

Код

Исходный текст

    Код с отступом в 4 пробела (tab)

Встроенный `код` внутри предложения

    // Комментарии
    Строка 1 кода
    Строка 2 кода
    Строка 3 кода

Подсветка синтаксиса

```js
var foo = function (bar) {
  return bar;
};

console.log(foo(5));
```

Результат

Код с отступом в 4 пробела (tab)

Встроенный код внутри предложения

// Комментарии
Строка 1 кода
Строка 2 кода
Строка 3 кода

Подсветка синтаксиса

var foo = function (bar) {
  return bar;
};

console.log(foo(5));

Контейнеры

Исходный текст

:::
пример **выделения**
с `кодом` и ссылкой [link](https://tas-project.ru)
:::

::: info Информация
пример **выделения**
с `кодом` и ссылкой [link](https://tas-project.ru)
:::

::: tip Совет
пример **выделения**
с `кодом` и ссылкой [link](https://tas-project.ru)
:::

::: warning Внимание
пример **выделения**
с `кодом` и ссылкой [link](https://tas-project.ru)
:::

::: danger Осторожно
пример **выделения**
с `кодом` и ссылкой [link](https://tas-project.ru)
:::

::: danger Вложенные контейнеры
пример **выделения**
с `кодом` и ссылкой [link](https://tas-project.ru)
::: warning Внимание, отступ 2 пробела для вложенного контейнера
пример **выделения**
с `кодом` и ссылкой [link](https://tas-project.ru)
::::::

Результат

пример выделения с кодом и ссылкой link

Информация

пример выделения с кодом и ссылкой link

Совет

пример выделения с кодом и ссылкой link

Внимание

пример выделения с кодом и ссылкой link

Осторожно

пример выделения с кодом и ссылкой link

Вложенные контейнеры

пример выделения с кодом и ссылкой link

Внимание, отступ 2 пробела для вложенного контейнера

пример выделения с кодом и ссылкой link

Выделение текста

Исходный текст

**Это жирный текст**

**Это жирный текст, второй способ**

_Курсив_

_Курсив, второй способ_

**_Это жирный курсив_**

**_Это жирный курсив второй способ_**

~~Это зачеркнутый текст~~

++Подчеркнутый текст++

==Выделенный текст==

Текст в `рамке`

Результат

Это жирный текст

Это жирный текст, второй способ

Курсив

Курсив, второй способ

Это жирный курсив

Это жирный курсив второй способ

Это зачеркнутый текст

++Подчеркнутый текст++

Выделенный текст

Текст в рамке

Заголовки

Исходный текст

# Заголовок 1-го уровня

## Заголовок 2-го уровня

### Заголовок 3-го уровня

#### Заголовок 4-го уровня

##### Заголовок 5-го уровня

###### Заголовок 6-го уровня

Горизонтальная черта

Исходный текст

---

Изображения

Исходный текст

Изображение фиксированного размера 200x200 пикселей
![img](https://octodex.github.com/images/minion.png =200x200)
![img](https://octodex.github.com/images/minion.png "Подсказка" =200x200)

Изображение без указания размеров
![img](https://octodex.github.com/images/minion.png)
![img](https://octodex.github.com/images/minion.png "Подсказка")

Еще один способ вставки изображения - через определение ссылки.
Удобно, если одно и то же изображение нужно использовать несколько раз.

![img][my_image]

Вот определение ссылки:

[my_image]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"

Ссылки

Исходный текст

[Внешняя ссылка](https://tas-project.ru)

[Локальная ссылка](/osa)

[Ссылка на заголовок "Списки"](#Списки)

Если в заголовке есть пробелы, их нужно заменить на "-" (минус)
[Ссылка на заголовок "Горизонтальная черта"](#Горизонтальная-черта)

[Ссылка с подсказкой](https://tas-project.ru "Это подсказка!")

Автоконвертируемая ссылка: https://tas-project.ru

[my-link]: https://tas-project.ru

[Переиспользуемая ссылка][my-link] может быть использована
[несколько раз][my-link] по тексту документа.

Списки

Исходный текст

Неупорядоченный список:

- Создайте неупорядоченный список, начав строку со знаков `+`, `-` или `*`
- Подсписки имеют отступ в 2 пробела:
  - Еще один уровень:
    - аааааа
    - бббббб
    - вввввв
- Очень просто!

Упорядоченный список:

1. Создайте упорядоченный список, начав строку с числа, например, `1.`
2. ааааа
3. ббббб
4. ввввв

Начало нумерации с определенного значения:

57. foo
1. bar
1. baz

Неупорядоченный список:

• Создайте неупорядоченный список, начав строку со знаков +, - или *
• Подсписки имеют отступ в 2 пробела:
  • Еще один уровень:
    • аааааа
    • бббббб
    • вввввв
• Очень просто!

Упорядоченный список:

1. Создайте упорядоченный список, начав строку с числа, например, 1.
2. ааааа
3. ббббб
4. ввввв

Начало нумерации с определенного значения:

57. foo
58. bar
59. baz

Подстрочный / надстрочный текст

Исходный текст

- 19^th^ - надстрочный текст `th`
- H~2~O - подстрочный текст `2`

Автоматические замены

Исходный текст

(c) (C) (r) (R) (tm) (TM) (p) (P) +-

-- --- // длинные тире

Таблицы

Исходный текст

| Параметр | Описание |
| ------ | ----------- |
| data   | Lorem ipsum dolor sit amet, consectetur... |
| engine | Lorem ipsum dolor sit amet, consectetur adipiscing elit... |
| ext    |  |

Выравнивание в ячейках таблицы по правому краю:

| Параметр | Описание |
| ------:| -----------:|
| data   | Lorem ipsum dolor sit amet, consectetur... |
| engine |  |
| ext    | Lorem ipsum dolor sit amet... |

Выравнивание по центру:

| Параметр | Описание |
|:------:|:-----------:|
| data   |  |
| engine | Lorem ipsum dolor sit amet, consectetur adipiscing elit... |
| ext    | Lorem ipsum dolor sit amet... |

Результат

Параметр	Описание
data	Lorem ipsum dolor sit amet, consectetur...
engine	Lorem ipsum dolor sit amet, consectetur adipiscing elit...
ext

Выравнивание по правому краю

Параметр	Описание
data	Lorem ipsum dolor sit amet, consectetur...
engine
ext	Lorem ipsum dolor sit amet...

Выравнивание по центру

Параметр	Описание
data
engine	Lorem ipsum dolor sit amet, consectetur adipiscing elit...
ext	Lorem ipsum dolor sit amet...

Список задач

Исходный текст

- [ ] один
- [x] два
- [ ] три

1. [ ] один
2. [x] два
3. [ ] три

Экранирование символов

Исходный текст

Поставьте слэш перед \*специальным символом\*,
чтобы предотвратить стандартное поведение

Поставьте слэш перед *специальным символом*, чтобы предотвратить стандартное поведение

Видео

Исходный текст

Встроенное видео Youtube:
/i/https://www.youtube.com/embed/12sM1z9EGw0

Встроенный проигрыватель браузера:
<video controls="controls" width="100%">
 <source src="https://site.ru/rules-007.mp4">
</video>

Иконки

Список доступных для вставки в текст иконок - https://materialdesignicons.com/

Исходный текст

К названию иконки нужно добавить префикс `mdi-`

:mdi-plus-circle-outline@#ff0000: - иконка заданного цвета
:mdi-plus-circle-outline: - иконка без указания цвета

- иконка заданного цвета

- иконка без указания цвета

Семантический поиск

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

1. Кликните по иконке (Вставить семантический поиск)
2. В появившемся диалоговом окне выберите нужный семантический поиск из списка
3. Настройте параметры отображения семантического поиска в документе
4. Скопируйте сгенерированный код и вставьте в нужное место в документе

Нужно помнить

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

Поддерживаются следующие режимы отображения сводной таблицы:

• Таблица
• Тепловая карта
• Тепловая карта по столбцу
• Тепловая карта по строке

Формат строки семантического поиска

Формат строки семантического поиска после вставки в документ в режиме редактирования имеет следующий вид:

[НАЗВАНИЕ_ПОИСКА|:ss-ИДЕНТИФИКАТОР_ПОИСКА@ПАРАМЕТРЫ_ПОИСКА:]

• НАЗВАНИЕ_ПОИСКА - название вставленного семантического поиска
• ИДЕНТИФИКАТОР_ПОИСКА - идентификатор семантического поиска
• @ - разделитель (не обязательная часть), присутствует только в случае наличия параметров поиска
• ПАРАМЕТРЫ_ПОИСКА - параметры поиска (не обязательная часть)

Вот несколько примеров того, как может выглядеть строка семантического поиска в документе в режиме редактирования:

• [Мой поиск|:ss-f3dae6c1-4ce5-48eb-a9d4-04ce4936b511:]
• [Мой поиск|:ss-545ed35f-8e29-4a87-88e3-1a7fa9307411@groupField=idx151;headerLevel=0:]

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

Дополнительные условия для фильтрации результатов семантического поиска могут быть указаны в параметрах поиска в формате:

filter=КОД_КОЛОНКИ|ИДЕНТИФИКАТОР_ЭКЗЕМПЛЯРА

• КОД_КОЛОНКИ - код колонки семантического поиска, по которой необходимо осуществлять фильтрацию результатов
• ИДЕНТИФИКАТОР_ЭКЗЕМПЛЯРА - идентификатор, который будет использоваться в качестве ограничения при фильтрации результатов
• фильтрация может осуществляться сразу по нескольким колонкам; в этом случае необходимо разделить параметры точкой с запятой: filter=КОД_КОЛОНКИ|ИДЕНТИФИКАТОР_ЭКЗЕМПЛЯРА;filter=КОД_КОЛОНКИ_2|ИДЕНТИФИКАТОР_ЭКЗЕМПЛЯРА_2; если указаны несколько параметров фильтрации, то фильтрация будет работать в логике "И".

documentId

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

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

Примеры строк семантического поиска с указанными параметрами фильтрации:

• [Название поиска|:ss-f3dae6c1-4ce5-48eb-a9d4-04ce4936b511@filter=cls|2da30dce-ead7-401f-8b63-ff0490118ab7:] - для колонки семантического поиска с кодом cls будет использовано ограничение 2da30dce-ead7-401f-8b63-ff0490118ab7
• [Название поиска|:ss-545ed35f-8e29-4a87-88e3-1a7fa9307411@filter=doc|documentId:] - для колонки семантического поиска с кодом doc будет использован идентификатор того документа, в который вставлена эта строка

Онтологическая карта

Для отображения в документе графового представления онтологии:

1. Кликните по иконке (Вставить онтологию)
2. В появившемся диалоговом окне выберите нужную онтологию, укажите ориентацию графа и необходимость отображения скалярных свойств
3. Скопируйте сгенерированный код и вставьте в нужное место в документе

Диаграммы OSA

Для отображения в документе диаграммы OSA:

1. Кликните по иконке (Вставить диаграмму)
2. В появившемся диалоговом окне выберите нужную диаграмму
3. Скопируйте сгенерированный код и вставьте в нужное место в документе

Нужно помнить

В документе будут отображены только те диаграммы OSA, для которых имеются сохраненные SVG-представления. Сохраненное SVG-представление может отличаться от текущего состояния диаграммы.

Текстовые диаграммы

Описание синтаксиса диаграмм (на английском языке): https://mermaid-js.github.io/mermaid/#/flowchart.

Исходный текст

```mermaid
graph LR
A[Прямоугольник] -- Название связи --> B((Круг))
A --> C(Скругл. прямоугольник)
B --> D{Ромб}
C --> D
```

Результат

Определения (дискурсы) терминов

Сослаться в документе на какой-либо термин из базы знаний или базы фактов, можно следующим образом:

1. активируйте режим "Дискурсы термина" (иконка на панели инструментов)
2. начните писать название термина и нажмите комбинацию клавиш Ctrl+Пробел
3. появится выпадающий список терминов, чьи названия удовлетворяют введенной подстроке
4. выберите нужный термин с помощью клавиши Enter или кликните по нему левой клавишей мыши
5. термин будет добавлен в документ в квадратных скобках [ ]
   • если оставить термин в таком виде, то в режиме просмотра документа при клике по термину будут отображены все элементы дискурса термина
   • если сразу после закрывающей квадратной скобки ввести точку и нажать Ctrl+Пробел, то можно выбрать или конкретный элемент дискурса термина или все дискурсы определенного типа; в этом случае, в режиме просмотра документа, при клике по термину будут отображены только выбранные элементы дискурса

Совет

Если необходимо сослаться на термин, созданный другим пользователем, отключите галочку "Только мои объекты" в панели инструментов документа

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

[IdentifiedObject] - все элементы дискурса термина
[IdentifiedObject].[IdentifiedObject___определение］- конкретное определение термина
[IdentifiedObject].[Примечание_К］- все примечания термина

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

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

Ниже будут представлены [ут_Трeбование](требования) к приложению.

Совет

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

Значения свойств экземпляров

Для вывода в документе значения свойства экземпляра:

1. активируйте режим "Значение свойства экземпляра" (иконка на панели инструментов)
2. начните писать название экземпляра и нажмите комбинацию клавиш Ctrl+Пробел
3. появится выпадающий список экземпляров, чьи названия удовлетворяют введенной подстроке
4. выберите нужный экземпляр с помощью клавиши Enter или кликните по нему левой клавишей мыши
5. экземпляр будет добавлен в документ в квадратных скобках [ ]; сразу после закрывающей квадратной скобки введите точку, нажмите Ctrl+Пробел и выберите свойство, значение которого нужно вывести

Свойства класса **IdentifiedObject**:
[IdentifiedObject].[Обладает_свойствами］

Ссылки на документы

Если в каком-либо документе необходимо сослаться на другой документ, можно сделать это двумя способами:

1. Вставить ссылку на другой документ, как это описано в разделе Ссылки. При клике по ссылке, документ будет открываться в новой (или в текущей) вкладке браузера
2. Сослаться на содержание другого документа

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

1. начните писать название документа и нажмите комбинацию клавиш Ctrl+Пробел
2. появится выпадающий список терминов, чьи названия удовлетворяют введенной подстроке
3. выберите нужный термин (документ) с помощью клавиши Enter или кликните по нему левой клавишей мыши
4. термин будет добавлен в документ в квадратных скобках [ ]

В режиме редактирования документа добавленный термин будет выглядеть следующим образом:

Ознакомьтесь с документом［Руководство_по_настройке_семантического_поиска] перед началом работы.

Здесь Руководство_по_настройке_семантического_поиска - это название добавленного документа. В режиме просмотра добавленный таким образом документ выделяется цветом и при клике по нему всплывает окно, в котором отображается его содержимое.

Раскрывающиеся секции

Исходный текст

<details>
  <summary>Заголовок раскрывающейся секции</summary>
  Содержание раскрывающейся секции
</details>

<details>
  <summary>
    В заголовках раскрывающихся секций может отображаться только обычный текст
  </summary>

    А в содержании могут быть использованы элементы оформления - для этого нужно
    добавить пустые строки после закрывающего тега </summary> и перед
    закрывающим тегом </details>

  | Функция | Доступна ролям | |-|-| |**Редактирование проекта** |• Руководитель
  проекта<br />• Менеджер проекта<br />• Редактор проекта|

</details>

Результат

Заголовок раскрывающейся секции

Содержание раскрывающейся секции

В заголовках раскрывающихся секций может отображаться только обычный текст

А в содержании могут быть использованы элементы оформления - для этого нужно добавить пустые строки после закрывающего тега </summary> и перед закрывающим тегом </details>

Функция	Доступна ролям
Редактирование проекта	• Руководитель проекта • Менеджер проекта • Редактор проекта

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

<style>
  details {
    border: 1px solid #aaa;
    border-radius: 4px;
    padding: 0.5em 0.5em 0;
    margin-bottom: 8px;
  }

  summary {
    font-weight: bold;
    margin: -0.5em -0.5em 0;
    padding: 0.5em;
    cursor: pointer;
  }

  details[open] {
    padding: 0.5em;
  }

  details[open] summary {
    border-bottom: 1px solid #aaa;
    margin-bottom: 0.5em;
  }
</style>

<details>
  <summary>Заголовок секции с дополнительным оформлением</summary>

  ::: info Содержание секции с дополнительным оформлением :::
</details>

Заголовок секции с дополнительным оформлением

Информация

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

Дополнительные возможности

Если необходимо убрать границы у строк у таблицы и у изображений, нужно поместить содержимое таблицы с изображениями внутрь блока <div class="hide-borders">...</div>:

<div class="hide-borders">

|    |    |
| -- | -- |
| .. | .. |

</div>

По умолчанию размер изображений, вставленных в таблицу, подбирается автоматически (даже в том случае, если размер указан явно) Отменить такое поведение можно поместив таблицу в блок с классом reset-max-width:

<div class="reset-max-width">

|    |    |
| -- | -- |
| .. | .. |

</div>

Для использования многострочного текста в ячейках таблицы, необходимо использовать тег <br>:

| Функция        | Доступна ролям                               |
| -------------- | -------------------------------------------- |
| Редактирование | • Руководитель проекта<br>• Менеджер проекта |

Функция	Доступна ролям
Редактирование	• Руководитель проекта • Менеджер проекта

Математические формулы и выражения

Формулы, которые должны быть встроены в текст, заключите в символы \\(...\\), отдельностоящие формулы заключите в символы \\[...\\].

Исходный текст

Вот эта формула \\(\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}\\) будет отображаться в тексте.
А эта формула \\[\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}\\] будет отображаться отдельно.

Результат

Вот эта формула $(\sum _{i=0}^n{i}^2=\frac{(n^2+n)(2n+1)}{6})$ будет отображаться в тексте. А эта формула

$$\sum _{i=0}^n{i}^2=\frac{(n^2+n)(2n+1)}{6}$$

будет отображаться отдельно.

Подробнее об синтаксисе математических формул и выражений можно почитать на английском языке в статье MathJax basic tutorial and quick reference.