Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion cake/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ public override void Run(BuildContext context)
context.ProcessRunner.Start(@"dotnet", new Cake.Core.IO.ProcessSettings()
{
WorkingDirectory = context.DocumentationSource,
Arguments = $"docfx -t default,templates/material"
Arguments = $"docfx build"
}).WaitForExit();

//GenerateApiDocumentation(context, @$"ix.connectors\src\Ix.Connector\bin\{context.DotNetBuildSettings.Configuration}\net6.0\Ix.Connector.dll", @"Ix.Connector");
Expand Down
2 changes: 2 additions & 0 deletions docfx/articles/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
---
* [Documenation compiler](~/articles/ixd/IXD.md)
---
* [Resx compiler](~/articles/ixr/IXR.md)
---
* [Connectors](~/articles/connectors/README.md)
* [Dummy](~/articles/connectors/Dummy.md)
* [WebAPI](~/articles/connectors/WebAPI.md)
Expand Down
8 changes: 4 additions & 4 deletions docfx/articles/ixd/IXD.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ dotnet tool install Ix.ixd --prerelease --local
### 4. Generate documentation with ixd



```
~~~
dotnet ixd -x $PATH_TO_AX_PROJECT -o $PATH_TO_API_FOLDER
=======
~~~

where:

`$PATH_TO_AX_PROJECT` -- is path to AX project, which contains apax.yml file

`$PATH_TO_API_FOLDER` -- is path to `api` output folder, which is located in docfx project

### 5. Build and run docfx docset
Expand All @@ -64,7 +64,7 @@ Now you can preview the website on http://localhost:8080/api/.

Website should look something like this:

![alt text](assets/example-doc-web.png "example web")
![example web](~/images/ixd/example-doc-web.png "example web")

## Notes
Ixd is still in early development, so some features may be missing and bugs may occur.
Expand Down
43 changes: 43 additions & 0 deletions docfx/articles/ixr/IXR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# IXR - resx compiler for AX

Ixr is command line tool which can generate resx files for AX projects. Resx file contains localizable strings from project, that can be further used in translation.

## Quick start

### 1. Install ixr tool

~~~
dotnet tool install Ix.ixr --prerelease --local
~~~

### 2. Run ixr compiler

~~~
dotnet ixr -x $PATH_TO_AX_PROJECT -o $PATH_TO_RESX_FILE
~~~

where:
`$PATH_TO_AX_PROJECT` - is path to **AX project**
`$PATH_TO_RESX_FILE` - is path to **resx file**, where the localizable strings will be generated

Localizable string are exported only from string attributes and pragmas of attribute name.

## Localizable string

Localizable string must start with `<#` and end with `#>` tags.
For example:
`'<#This is localizable string#>'`

Also you can connecting localizable and non-localizable string together.
For example:
`'This is non-localizable string <#This is localizable string#>'`

## Special characters

Ixr support all these special characters:
``!"#$'()*+,-.:;<=>?@[\]^_`{|}~€``
No other characters can be used.

## Notes

Ixr is still in early development, so some features may be missing and bugs may occur.
5 changes: 3 additions & 2 deletions docfx/articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
href: ~/articles/conceptual/Conceptual.md
- name: Getting started
href: ~/index.md#getting-started
- name: Compiler
- name: Twin Compiler
href: ~/articles/compiler/README.md
items:
- name: Attributes
Expand All @@ -18,7 +18,8 @@

- name: Documenation compiler
href: ~/articles/ixd/IXD.md

- name: Localizables compiler
href: ~/articles/ixr/IXR.md
- name: Connectors
href: ~/articles/connectors/README.md
items:
Expand Down
4 changes: 1 addition & 3 deletions docfx/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,7 @@
"dest": "../docs",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
["default","templates/material"]
],
"template": ["default", "templates/material", "templates/mermaid", "templates/custom"],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
Expand Down
14 changes: 14 additions & 0 deletions docfx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@

**IX is an open-source project developed by a group of automation engineers. It provides easy access from .NET-based applications to SIMATIC-AX based PLC programs.**

Open source repository is [here](https://github.com/ix-ax/ix).

>[!NOTE]
>This project is under development. We periodically release versions that can be used for testing and in non-production environments.




## Disclaimer

>[!IMPORTANT]
> **It is necessary to have a valid license for SIMATIC AX in order to use IX!**
SIMATIC AX is currently in a limited sales release in selected European countries only. You will need to request access from the AX team which will check if your use case is suitable for the current state of the product. The first step to getting the approval is contacting your local SIEMENS sales representative or writing an email to [simatic-ax@siemens.com](mailto:simatic-ax@siemens.com?subject=Request%20for%20access%20|%20SIMATIC%20AX%20for%20IX).

## What's in

## [Ix.ixc compiler](~/articles/compiler/README.md)
Expand Down
5 changes: 5 additions & 0 deletions docfx/templates/custom/partials/logo.tmpl.partial
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}

<a class="navbar-brand" href="{{_rel}}index.html">
<p class="text-logo">IX</p>
</a>
12 changes: 12 additions & 0 deletions docfx/templates/custom/styles/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.text-logo{
font-weight: bold;
font-size: large;
margin:15px;
color:-webkit-linear-gradient(#0d47a1 , #5e92f3);
}

.text-logo:hover{
background: -webkit-linear-gradient(#5e92f3,#0d47a1);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
}
3 changes: 2 additions & 1 deletion docfx/templates/material/partials/head.tmpl.partial
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
<link rel="stylesheet" href="{{_rel}}styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<link rel="stylesheet" href="{{_rel}}styles/custom.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="{{_navRel}}">
<meta property="docfx:tocrel" content="{{_tocRel}}">
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
Expand Down
14 changes: 14 additions & 0 deletions docfx/templates/mermaid/partials/scripts.tmpl.partial
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<script type="text/javascript" src="{{_rel}}styles/docfx.vendor.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/highlight.min.js"></script>
<script src="https://unpkg.com/highlightjs-dotnetconfig@0.9.3/dist/dotnetconfig.min.js"></script>
<script type="text/javascript" src="{{_rel}}styles/docfx.js"></script>
<script type="text/javascript" src="{{_rel}}styles/main.js"></script>
<script type="text/javascript" src="https://unpkg.com/mermaid@8.10.2/dist/mermaid.min.js"
integrity="sha384-nzpOk138h0/O14Ig1PAUlf1XSo5T+XvpBUVkpLaU40QBvMgrNkSKusdNAomDLEd2"
crossorigin="anonymous"></script>
<script>
mermaid.initialize({
startOnLoad: false
});
mermaid.init(undefined, ".lang-mermaid");
</script>
19 changes: 13 additions & 6 deletions docs/api/IX.Compiler.Core.IxNodeVisitor.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<link rel="stylesheet" href="../styles/custom.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

Expand All @@ -37,9 +38,8 @@
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="IX">
</a>
</div>
<p class="text-logo">IX</p>
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
Expand Down Expand Up @@ -8314,9 +8314,16 @@ <h5>In This Article</h5>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/highlight.min.js"></script>
<script src="https://unpkg.com/highlightjs-dotnetconfig@0.9.3/dist/dotnetconfig.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
<script type="text/javascript" src="https://unpkg.com/mermaid@8.10.2/dist/mermaid.min.js" integrity="sha384-nzpOk138h0/O14Ig1PAUlf1XSo5T+XvpBUVkpLaU40QBvMgrNkSKusdNAomDLEd2" crossorigin="anonymous"></script>
<script>
mermaid.initialize({
startOnLoad: false
});
mermaid.init(undefined, ".lang-mermaid");
</script> </body>
</html>
19 changes: 13 additions & 6 deletions docs/api/IX.Compiler.Core_1.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<link rel="stylesheet" href="../styles/custom.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

Expand All @@ -37,9 +38,8 @@
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="IX">
</a>
</div>
<p class="text-logo">IX</p>
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
Expand Down Expand Up @@ -126,9 +126,16 @@ <h5>In This Article</h5>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/highlight.min.js"></script>
<script src="https://unpkg.com/highlightjs-dotnetconfig@0.9.3/dist/dotnetconfig.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
<script type="text/javascript" src="https://unpkg.com/mermaid@8.10.2/dist/mermaid.min.js" integrity="sha384-nzpOk138h0/O14Ig1PAUlf1XSo5T+XvpBUVkpLaU40QBvMgrNkSKusdNAomDLEd2" crossorigin="anonymous"></script>
<script>
mermaid.initialize({
startOnLoad: false
});
mermaid.init(undefined, ".lang-mermaid");
</script> </body>
</html>
19 changes: 13 additions & 6 deletions docs/api/Ix.Abstractions.Presentation.EmptyGroupProvider.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<link rel="stylesheet" href="../styles/custom.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

Expand All @@ -37,9 +38,8 @@
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="IX">
</a>
</div>
<p class="text-logo">IX</p>
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
Expand Down Expand Up @@ -214,9 +214,16 @@ <h5>In This Article</h5>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/highlight.min.js"></script>
<script src="https://unpkg.com/highlightjs-dotnetconfig@0.9.3/dist/dotnetconfig.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
<script type="text/javascript" src="https://unpkg.com/mermaid@8.10.2/dist/mermaid.min.js" integrity="sha384-nzpOk138h0/O14Ig1PAUlf1XSo5T+XvpBUVkpLaU40QBvMgrNkSKusdNAomDLEd2" crossorigin="anonymous"></script>
<script>
mermaid.initialize({
startOnLoad: false
});
mermaid.init(undefined, ".lang-mermaid");
</script> </body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<link rel="stylesheet" href="../styles/custom.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

Expand All @@ -37,9 +38,8 @@
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="IX">
</a>
</div>
<p class="text-logo">IX</p>
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
Expand Down Expand Up @@ -214,9 +214,16 @@ <h5>In This Article</h5>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/highlight.min.js"></script>
<script src="https://unpkg.com/highlightjs-dotnetconfig@0.9.3/dist/dotnetconfig.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
<script type="text/javascript" src="https://unpkg.com/mermaid@8.10.2/dist/mermaid.min.js" integrity="sha384-nzpOk138h0/O14Ig1PAUlf1XSo5T+XvpBUVkpLaU40QBvMgrNkSKusdNAomDLEd2" crossorigin="anonymous"></script>
<script>
mermaid.initialize({
startOnLoad: false
});
mermaid.init(undefined, ".lang-mermaid");
</script> </body>
</html>
19 changes: 13 additions & 6 deletions docs/api/Ix.Abstractions.Presentation.IGroupLayoutProvider.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<link rel="stylesheet" href="../styles/custom.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

Expand All @@ -37,9 +38,8 @@
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="IX">
</a>
</div>
<p class="text-logo">IX</p>
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
Expand Down Expand Up @@ -177,9 +177,16 @@ <h5>In This Article</h5>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/highlight.min.js"></script>
<script src="https://unpkg.com/highlightjs-dotnetconfig@0.9.3/dist/dotnetconfig.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
<script type="text/javascript" src="https://unpkg.com/mermaid@8.10.2/dist/mermaid.min.js" integrity="sha384-nzpOk138h0/O14Ig1PAUlf1XSo5T+XvpBUVkpLaU40QBvMgrNkSKusdNAomDLEd2" crossorigin="anonymous"></script>
<script>
mermaid.initialize({
startOnLoad: false
});
mermaid.init(undefined, ".lang-mermaid");
</script> </body>
</html>
Loading