Skip to content

Commit

Permalink
Convert all code to kotlin and add some features
Browse files Browse the repository at this point in the history
  • Loading branch information
jaakkonakaza committed Aug 2, 2024
1 parent 1d94344 commit 72ecb41
Show file tree
Hide file tree
Showing 567 changed files with 10,805 additions and 30,481 deletions.
68 changes: 0 additions & 68 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1,031 changes: 1,031 additions & 0 deletions .idea/inspectionProfiles/Project_Default.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .run/Run Plugin.run.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Run Plugin" type="GradleRunConfiguration" factoryName="Gradle">
<log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log"/>
<log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/IC-2024.2/log/idea.log"/>
<ExternalSystemSettings>
<option name="executionName"/>
<option name="externalProjectPath" value="$PROJECT_DIR$"/>
Expand Down
14 changes: 14 additions & 0 deletions Writerside/ac.tree
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="ac"
name="A+ Courses"
start-page="starter-topic.md">

<toc-element topic="starter-topic.md">
<toc-element topic="API_Reference.md">
<toc-element topic="courses_GET.md"/>
</toc-element>
</toc-element>
</instance-profile>
6 changes: 6 additions & 0 deletions Writerside/c.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="wrs" name="Writerside documentation" order="1"/>
</categories>
12 changes: 12 additions & 0 deletions Writerside/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<variables></variables>
<build-profile instance="ac">
<variables>
<noindex-content>false</noindex-content>
</variables>
</build-profile>

</buildprofiles>
89 changes: 89 additions & 0 deletions Writerside/topics/Empty-MD-Topic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# About A+ Courses

<!--Writerside adds this topic when you create a new documentation project.
You can use it as a sandbox to play with Writerside features, and remove it from the TOC when you don't need it anymore.-->

## 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:

<procedure title="Inject a procedure" id="inject-a-procedure">
<step>
<p>Start typing and select a procedure type from the completion suggestions:</p>
<img src="completion_procedure.png" alt="completion suggestions for procedure" border-effect="line"/>
</step>
<step>
<p>Press <shortcut>Tab</shortcut> or <shortcut>Enter</shortcut> to insert the markup.</p>
</step>
</procedure>

## 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):

<tabs>
<tab title="Markdown">
<code-block lang="plain text">![Alt Text](new_topic_options.png){ width=450 }</code-block>
</tab>
<tab title="Semantic markup">
<code-block lang="xml">
<![CDATA[<img src="new_topic_options.png" alt="Alt text" width="450px"/>]]></code-block>
</tab>
</tabs>

### 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 <shortcut>Alt+Enter</shortcut>:

<img src="convert_table_to_xml.png" alt="Convert table to XML" width="706" border-effect="line"/>

## Feedback and support

Please report any issues, usability improvements, or feature requests to our
<a href="https://youtrack.jetbrains.com/newIssue?project=WRS">YouTrack project</a>
(you will need to register).

You are welcome to join our
<a href="https://jb.gg/WRS_Slack">public Slack workspace</a>.
Before you do, please read our [Code of conduct](https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-code-of-conduct.html).
We assume that you’ve read and acknowledged it before joining.

You can also always email us at [[email protected]](mailto:[email protected]).

<seealso>
<category ref="wrs">
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html">Markup reference</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/manage-table-of-contents.html">Reorder topics in the TOC</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html">Build and publish</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/configure-search.html">Configure Search</a>
</category>
</seealso>
3 changes: 3 additions & 0 deletions Writerside/topics/aplus-lms.yaml/API_Reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# API Reference

Start typing here...
3 changes: 3 additions & 0 deletions Writerside/topics/aplus-lms.yaml/courses_GET.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# /courses GET

<api-endpoint openapi-path="../../../aplus-lms.yaml" method="GET" endpoint="/courses"/>
131 changes: 131 additions & 0 deletions Writerside/topics/starter-topic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<section-starting-page>
<title>This is the title</title>
<description>Description of the starting page</description>

<spotlight>
<a href="some_topic. topic" description="First topic description.">Some topic</a>
<a href="some_other_topic. topic" description="Second topic description.">Some other topic</a>
</spotlight>

<primary>
<title>Main group title</title>
<a href="some_topic. topic" description="First topic description.">Some topic</a>
<a href="some_other_topic. topic" description="Second topic description.">Some other topic</a>
...
</primary>

<secondary>
<title>highlighted group title</title>
<a href="some_topic. topic" description="First topic description.">Some topic</a>
<a href="some_other_topic. topic" description="Second topic description.">Some other topic</a>
...
</secondary>

<misc>
<cards narrow="false">
<title>Other tools</title>
<a href="some_topic. topic" description="First topic description.">Some topic</a>
<a href="some_other_topic. topic" description="Second topic description.">Some other topic</a>
...
</cards>

<links narrow="true">
<group>
<title>Frameworks</title>
<a href="some_topic. topic" description="First topic description.">Some topic</a>
<a href="some_other_topic. topic" description="Second topic description.">Some other topic</a>
...
</group>
...
</links>
</misc>
</section-starting-page>
# About A+ Courses

<!--Writerside adds this topic when you create a new documentation project.
You can use it as a sandbox to play with Writerside features, and remove it from the TOC when you don't need it anymore.-->

## 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:

<procedure title="Inject a procedure" id="inject-a-procedure">
<step>
<p>Start typing and select a procedure type from the completion suggestions:</p>
<img src="completion_procedure.png" alt="completion suggestions for procedure" border-effect="line"/>
</step>
<step>
<p>Press <shortcut>Tab</shortcut> or <shortcut>Enter</shortcut> to insert the markup.</p>
</step>
</procedure>

## 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):

<tabs>
<tab title="Markdown">
<code-block lang="plain text">![Alt Text](new_topic_options.png){ width=450 }</code-block>
</tab>
<tab title="Semantic markup">
<code-block lang="xml">
<![CDATA[<img src="new_topic_options.png" alt="Alt text" width="450px"/>]]></code-block>
</tab>
</tabs>

### 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 <shortcut>Alt+Enter</shortcut>:

<img src="convert_table_to_xml.png" alt="Convert table to XML" width="706" border-effect="line"/>

## Feedback and support

Please report any issues, usability improvements, or feature requests to our
<a href="https://youtrack.jetbrains.com/newIssue?project=WRS">YouTrack project</a>
(you will need to register).

You are welcome to join our
<a href="https://jb.gg/WRS_Slack">public Slack workspace</a>.
Before you do, please read our [Code of conduct](https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-code-of-conduct.html).
We assume that you’ve read and acknowledged it before joining.

You can also always email us at [[email protected]](mailto:[email protected]).

<seealso>
<category ref="wrs">
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html">Markup reference</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/manage-table-of-contents.html">Reorder topics in the TOC</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html">Build and publish</a>
<a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/configure-search.html">Configure Search</a>
</category>
</seealso>
5 changes: 5 additions & 0 deletions Writerside/v.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
<vars>
<var name="product" value="Writerside"/>
</vars>
8 changes: 8 additions & 0 deletions Writerside/writerside.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">

<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<instance src="ac.tree" version="4.0.0-beta1"/>
</ihp>
Loading

0 comments on commit 72ecb41

Please sign in to comment.