From 69a032309742dfd989db08986d3de93aaef911ec Mon Sep 17 00:00:00 2001 From: Orange Date: Sat, 29 Mar 2025 17:47:50 +0300 Subject: [PATCH] added files --- writerside/c.list | 6 ++ writerside/cfg/buildprofiles.xml | 13 ++++ writerside/images/completion_procedure.png | 3 + .../images/completion_procedure_dark.png | 3 + writerside/images/convert_table_to_xml.png | 3 + .../images/convert_table_to_xml_dark.png | 3 + writerside/images/new_topic_options.png | 3 + writerside/images/new_topic_options_dark.png | 3 + writerside/o.tree | 10 +++ writerside/redirection-rules.xml | 13 ++++ writerside/topics/starter-topic.md | 78 +++++++++++++++++++ writerside/v.list | 5 ++ writerside/writerside.cfg | 8 ++ 13 files changed, 151 insertions(+) create mode 100644 writerside/c.list create mode 100644 writerside/cfg/buildprofiles.xml create mode 100644 writerside/images/completion_procedure.png create mode 100644 writerside/images/completion_procedure_dark.png create mode 100644 writerside/images/convert_table_to_xml.png create mode 100644 writerside/images/convert_table_to_xml_dark.png create mode 100644 writerside/images/new_topic_options.png create mode 100644 writerside/images/new_topic_options_dark.png create mode 100644 writerside/o.tree create mode 100644 writerside/redirection-rules.xml create mode 100644 writerside/topics/starter-topic.md create mode 100644 writerside/v.list create mode 100644 writerside/writerside.cfg diff --git a/writerside/c.list b/writerside/c.list new file mode 100644 index 0000000..c4c77a2 --- /dev/null +++ b/writerside/c.list @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/writerside/cfg/buildprofiles.xml b/writerside/cfg/buildprofiles.xml new file mode 100644 index 0000000..d265420 --- /dev/null +++ b/writerside/cfg/buildprofiles.xml @@ -0,0 +1,13 @@ + + + + + + + + true + + + + diff --git a/writerside/images/completion_procedure.png b/writerside/images/completion_procedure.png new file mode 100644 index 0000000..c079b71 --- /dev/null +++ b/writerside/images/completion_procedure.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c541027fb796a947f1f559a62dbd31f55a80f652e991d059112475d122d324c4 +size 128146 diff --git a/writerside/images/completion_procedure_dark.png b/writerside/images/completion_procedure_dark.png new file mode 100644 index 0000000..dee45a8 --- /dev/null +++ b/writerside/images/completion_procedure_dark.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59e7c2df47f33658fe75a75b346d573b7165ff11a99799c9db040a4bfa1ed225 +size 68718 diff --git a/writerside/images/convert_table_to_xml.png b/writerside/images/convert_table_to_xml.png new file mode 100644 index 0000000..4b8b6a1 --- /dev/null +++ b/writerside/images/convert_table_to_xml.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d6900b3f178e3213cbf9b0846b887cc154c15cf1f71e6a6a75cd16cf4c4f762 +size 349338 diff --git a/writerside/images/convert_table_to_xml_dark.png b/writerside/images/convert_table_to_xml_dark.png new file mode 100644 index 0000000..0580289 --- /dev/null +++ b/writerside/images/convert_table_to_xml_dark.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:449bfd5c17b5ccf25f6077a286988163a19b527522c3a53fd66fefa9b29b291b +size 121495 diff --git a/writerside/images/new_topic_options.png b/writerside/images/new_topic_options.png new file mode 100644 index 0000000..a11c4a2 --- /dev/null +++ b/writerside/images/new_topic_options.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7659fef226291431499d3f5f7b2faaa06540f1f21bf8cc9e4f6613c8b4904ad0 +size 313855 diff --git a/writerside/images/new_topic_options_dark.png b/writerside/images/new_topic_options_dark.png new file mode 100644 index 0000000..391b9b4 --- /dev/null +++ b/writerside/images/new_topic_options_dark.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce366a6c690d72ebe72b942ddefbb9ea7cf9d0bbfa03df2524e4e56e91b54546 +size 281000 diff --git a/writerside/o.tree b/writerside/o.tree new file mode 100644 index 0000000..a5ea91a --- /dev/null +++ b/writerside/o.tree @@ -0,0 +1,10 @@ + + + + + + + \ No newline at end of file diff --git a/writerside/redirection-rules.xml b/writerside/redirection-rules.xml new file mode 100644 index 0000000..e06c457 --- /dev/null +++ b/writerside/redirection-rules.xml @@ -0,0 +1,13 @@ + + + + + + " from OMATH]]> + Empty-MD-Topic.html + + \ No newline at end of file diff --git a/writerside/topics/starter-topic.md b/writerside/topics/starter-topic.md new file mode 100644 index 0000000..7fcb3d0 --- /dev/null +++ b/writerside/topics/starter-topic.md @@ -0,0 +1,78 @@ +# About OMATH + +Oranges's Math Library (omath) is a comprehensive, open-source library aimed at providing efficient, reliable, and versatile mathematical functions and algorithms. Developed primarily in C++, this library is designed to cater to a wide range of mathematical operations essential in scientific computing, engineering, and academic research. + +## Add new topics +You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started: + +![Create new topic options](new_topic_options.png){ width=290 }{border-effect=line} + +## Write content +%product% supports two types of markup: Markdown and XML. +When you create a new help article, you can choose between two topic types, but this doesn't mean you have to stick to a single format. +You can author content in Markdown and extend it with semantic attributes or inject entire XML elements. + +## Inject XML +For example, this is how you inject a procedure: + + + +

Start typing and select a procedure type from the completion suggestions:

+ completion suggestions for procedure + + +

Press Tab or Enter to insert the markup.

+ + + +## Add interactive elements + +### Tabs +To add switchable content, you can make use of tabs (inject them by starting to type `tab` on a new line): + + + + ![Alt Text](new_topic_options.png){ width=450 } + + + + ]]> + + + +### Collapsible blocks +Apart from injecting entire XML elements, you can use attributes to configure the behavior of certain elements. +For example, you can collapse a chapter that contains non-essential information: + +#### Supplementary info {collapsible="true"} +Content under a collapsible header will be collapsed by default, +but you can modify the behavior by adding the following attribute: +`default-state="expanded"` + +### Convert selection to XML +If you need to extend an element with more functions, you can convert selected content from Markdown to semantic markup. +For example, if you want to merge cells in a table, it's much easier to convert it to XML than do this in Markdown. +Position the caret anywhere in the table and press Alt+Enter: + +Convert table to XML + +## Feedback and support +Please report any issues, usability improvements, or feature requests to our +YouTrack project +(you will need to register). + +You are welcome to join our +public Slack workspace. +Before you do, please read our [Code of conduct](https://www.jetbrains.com/help/writerside/writerside-code-of-conduct.html). +We assume that you’ve read and acknowledged it before joining. + +You can also always email us at [writerside@jetbrains.com](mailto:writerside@jetbrains.com). + + + + Markup reference + Reorder topics in the TOC + Build and publish + Configure Search + + \ No newline at end of file diff --git a/writerside/v.list b/writerside/v.list new file mode 100644 index 0000000..2d12cb3 --- /dev/null +++ b/writerside/v.list @@ -0,0 +1,5 @@ + + + + + diff --git a/writerside/writerside.cfg b/writerside/writerside.cfg new file mode 100644 index 0000000..4e8ae9e --- /dev/null +++ b/writerside/writerside.cfg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file