Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

asdページを追加 #21

Merged
merged 4 commits into from
Dec 10, 2022
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions _includes/manuals/1.0/en/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,22 @@
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/tutorial.html' %}active{% endif %}" href="/manuals/1.0/en/tutorial.html">Tutorial</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/reference.html' %}active{% endif %}" href="/manuals/1.0/en/reference.html">Reference</a>
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/reference.html' %}active{% endif %}" href="/manuals/1.0/en/reference.html">ALPS Reference</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/best_practice.html' %}active{% endif %}" href="/manuals/1.0/en/best_practice.html">Best Practise</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/shared_vocabulary.html' %}active{% endif %}" href="/manuals/1.0/en/shared_vocabulary.html">Shared Vocabulary</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/asd.html' %}active{% endif %}" href="/manuals/1.0/en/asd.html">asd</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/example.html' %}active{% endif %}" href="/manuals/1.0/en/example.html">Example</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/link.html' %}active{% endif %}" href="/manuals/1.0/en/link.html">Link</a>
<a class="nav-link {% if page.permalink == '/manuals/1.0/en/link.html' %}active{% endif %}" href="/manuals/1.0/en/link.html">Resource</a>
</li>
</ul>
</div>
Expand Down
8 changes: 6 additions & 2 deletions _includes/manuals/1.0/ja/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,24 @@
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/tutorial.html' %}active{% endif %}" href="/manuals/1.0/ja/tutorial.html">チュートリアル</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/reference.html' %}active{% endif %}" href="/manuals/1.0/ja/reference.html">リファレンス</a>
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/reference.html' %}active{% endif %}" href="/manuals/1.0/ja/reference.html">ALPSリファレンス</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/best_practice.html' %}active{% endif %}" href="/manuals/1.0/ja/best_practice.html">ベストプラクティス</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/shared_vocabulary.html' %}active{% endif %}" href="/manuals/1.0/ja/shared_vocabulary.html">共有ボキャブラリ</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/asd.html' %}active{% endif %}" href="/manuals/1.0/ja/asd.html">asd</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/example.html' %}active{% endif %}" href="/manuals/1.0/ja/example.html">例</a>
</li>
<li class="nav-item">
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/link.html' %}active{% endif %}" href="/manuals/1.0/ja/link.html">リンク</a>
<a class="nav-link {% if page.permalink == '/manuals/1.0/ja/link.html' %}active{% endif %}" href="/manuals/1.0/ja/link.html">リソース</a>
</li>

</ul>
</div>
</nav>
95 changes: 95 additions & 0 deletions manuals/1.0/en/asd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
layout: docs-en
title: asd
category: Manual
permalink: /manuals/1.0/en/asd.html
---

# asd

The `asd` tool converts ALPS files to ASD documents.

```
asd [options] [alpsFile]

-c, --config=asd.xml
Path to a asd.xml configuration file

-w, --watch
Watch mode

--and-tag={tag1, tag2} --or-tag={tag3} [--color=red]
Filter graph

-m, --mode={markdown|html}
Output format

--port
Port number used in watch mode
```

If `asd` is run without arguments, a configuration file named `asd.xml` in the same folder is used.

## asd.xml config file

Example)
```xml
<?xml version="1.0"?>
<asd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="docs/asd.xsd">
<alpsFile>profile.xml</alpsFile>
<watch>false</watch>
<mode>markdown</mode>
</asd>
```

### Optional <asd /> attributes

### watch

```xml
<asd>
<watch>[bool]</watch>
</asd>
```

You can start ASD development server with watch mode.
Each time the profile file changes, the page is reloaded.

If you want to start with a specific port number, you can specify the port number at startup as follows.

```xml
<asd>
<port>3001</port>
</asd>
```

### filter

```xml
<asd>
<filter>
<and>[string]</and>
<and>[string]</and>
<or>[string]</or>
<color>[string]</color>
</filter>
</asd>
```

You can extract partial graphs by specific tags, or color specific graphs.

Specify a tag name in the "or" or "and" field to specify the condition. If you specify "color", the graph for that condition will be colored, but if you don't, only the graph for that condition will be extracted and drawn.

### markdown format

If your repository is private and your account is not a GHE or GHE Cloud account, you cannot make GitHub Pqges private. In such a case, you can output the document as Markdown and make the document private.

Unfortunately there is no way to host linked SVGs (diagrams) in Markdown, the dialog will lose the link when in Markdown.

This is an option if public HTML is not possible.

```xml
<asd>
<mode>markdown</mode>
</asd>
```
4 changes: 2 additions & 2 deletions manuals/1.0/en/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: Links
category: Manual
permalink: /manuals/1.0/en/link.html
---
# Links
# Resource

* [ALPS official](http://alps.io/)
* [RFC](https://datatracker.ietf.org/doc/html/draft-amundsen-richardson-foster-alps-07)
* Skeleton.
* Skeleton
* [json](https://github.com/alps-asd/alps-skeleton-json)
* [xml](https://github.com/alps-asd/alps-skeleton-xml)
* [GitHub Action](https://github.com/marketplace/actions/app-state-diagram)
Expand Down
94 changes: 94 additions & 0 deletions manuals/1.0/ja/asd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
layout: docs-ja
title: asd
category: Manual
permalink: /manuals/1.0/ja/asd.html
---

# asd

`asd`ツールはALPSファイルをASDドキュメントに変換します。

```
asd [options] [alpsFile]

-c, --config=asd.xml
設定ファイル

-w, --watch
   ウオッチモード

--and-tag={tag1, tag2} --or-tag={tag3} [--color=red]
フィルターのためのタグ

-m, --mode={markdown|html}
出力フォーマット

--port
利用ポート(デフォルト3000)
```

`asd`を引数なしで実行した場合、同じフォルダにある `asd.xml` という設定ファイルが使用されます。


## asd.xml 設定ファイル

例)
```xml
<?xml version="1.0"?>
<asd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="docs/asd.xsd">
<alpsFile>profile.xml</alpsFile>
<watch>false</watch>
<mode>markdown</mode>
</asd>
```

### watch

```xml
<asd>
<watch>[bool]</watch>
</asd>
```

ウォッチモードでASD開発サーバを起動することができます。
プロファイルファイルが変更されるたびに、ページが再読み込みされます。

### filter

```xml
<asd>
<filter>
<and>[string]</and>
<and>[string]</and>
<or>[string]</or>
<color>[string]</color>
</filter>
</asd>
```

特定のタグで部分的にグラフを抽出したり、特定のグラフに色をつけたりすることができます。

条件を指定するには、`or` または `and`の欄にタグ名を指定します。`color`を指定すると、その条件のグラフに色をつけますが、指定しない場合はその条件のグラフのみを抽出して描画します。

### label

```xml
<asd>
<label>[string]</label>
</asd>
```

グラフにラベルを指定します。

### mode

リポジトリが非公開でアカウントがGHEやGHE Cloudのアカウントでない場合、GitHub Pqgesを非公開にすることができません。そのような場合は、Markdownで出力し、ドキュメントを非公開にすることができます。

残念ながらリンクされたSVGのダイアグラムをMarkdownでホストする方法はありません。Markdownにするとダイアログはリンクを失います。 MarkdownはHTMLを公開できない場合のオプションです。
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
残念ながらリンクされたSVGのダイアグラムをMarkdownでホストする方法はありません。Markdownにするとダイアログはリンクを失います。 MarkdownはHTMLを公開できない場合のオプションです。
残念ながらリンクされたSVGの遷移図をMarkdownでホストする方法はありません。Markdownにすると遷移図はリンクを失います。 MarkdownはHTMLを公開できない場合のオプションです。

@NaokiTsuchiya 遷移図にしました!


```xml
<asd>
<mode>markdown</mode>
</asd>
```
2 changes: 1 addition & 1 deletion manuals/1.0/ja/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ category: Manual
permalink: /manuals/1.0/ja/link.html
---

# リンク
# リソース

* [ALPS 公式](http://alps.io/)
* [RFC](https://datatracker.ietf.org/doc/html/draft-amundsen-richardson-foster-alps-07)
Expand Down