generated from koriym/user-manual-skeleton
-
Notifications
You must be signed in to change notification settings - Fork 1
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
asdページを追加 #21
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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を公開できない場合のオプションです。 | ||
|
||
```xml | ||
<asd> | ||
<mode>markdown</mode> | ||
</asd> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@NaokiTsuchiya 遷移図にしました!