Commit 9533e958 authored by AP matsuo koji's avatar AP matsuo koji 😲

publish

parent 3687ae90
:toc: left
:temp: ./temp
:sectnums:
:sectnumlevels: 5
:experimental:
:toclevels: 3
:toc-title: 目次
:experimental:
= PlantUML関連のサンプル(雑に)
以下からサンプル::
https://dtm3110.hatenablog.com/entry/2019/11/05/113000
★これは定型的に記述する
----
.ラベルタイトル
説明
[plantuml,"{temp}/{counter:uml}",svg]
....
@startuml
....
@enduml
....
----
---
== コンポーネント図
説明
[plantuml,"{temp}/{counter:uml}",svg]
....
@startuml
' ヘッダー・フッターを読み込み & スタイル定義ファイル読み込み
skinparam componentStyle uml2
title コンポーネント図
package "認証認可パッケージ" {
[認証]
[ユーザー操作]
}
cloud "CloudファンクションAPI" {
[認証API]
[ユーザーAPI]
}
database "BigQuery" {
[ユーザーデータ]
[閲覧情報]
}
[認証] <--> [認証API]
[ユーザー操作] --> [認証API]
[ユーザー操作] <--> [ユーザーAPI]
[認証API] <--> [ユーザーデータ]
[ユーザーAPI] <--> [ユーザーデータ]
[ユーザーAPI] <--> [閲覧情報]
@enduml
....
---
== ユースケース
説明
[plantuml,"{temp}/{counter:uml}",svg]
....
@startuml
' ヘッダー・フッターを読み込み & スタイル定義ファイル読み込み
title 矢印
left to right direction
:アクター1: -> (ユースケース1)
:アクター1: -------> (ユースケース2)
:アクター1: ..|> :アクター2: : <<extend>>
:アクター2: ..|> :アクター3: : <<include>>
:アクター3: -left-> ()
:アクター3: -right-> ()
:アクター3: -up-> ()
:アクター3: -down-> ()
@enduml
....
== フローチャート
説明
[plantuml,"{temp}/{counter:uml}",svg]
....
@startuml
' ヘッダー・フッターを読み込み & スタイル定義ファイル読み込み
title 条件文
start
if (A or B) then (A)
:Aを選んだらこっち;
elseif (A or B) then (B)
:Bを選んだらこっち;
stop
else
:どれも選ばなかったらこっち;
stop
endif
stop
@enduml
....
---
== 境界線・遅延・間隔
説明
[plantuml,"{temp}/{counter:uml}",svg]
....
@startuml
' ヘッダー・フッターを読み込み & スタイル定義ファイル読み込み
title 境界線・遅延・間隔
' 境界線
== 境界線 ==
FUGA --> HOGE: Authentication Request
HOGE --> FUGA: Authentication Response
' 遅延
...
FUGA --> HOGE: Another authentication Request
HOGE --> FUGA: another authentication Response
' 間隔50px
||50||
FUGA --> HOGE: Another authentication Request
HOGE --> FUGA: another authentication Response
@enduml
....
---
== ライブラリーインポート(AWS)
説明
[plantuml,"{temp}/{counter:uml}",svg]
....
@startuml
!include <aws/common>
!include <aws/Storage/AmazonS3/AmazonS3>
!include <aws/Storage/AmazonS3/bucket/bucket>
skinparam Shadowing false
title ライブラリーインポート(AWS)
AMAZONS3(s3_internal)
AMAZONS3(s3_partner,"Vendor's S3")
s3_internal <- s3_partner
@enduml
....
---
== コメント・注釈
説明
[plantuml,"{temp}/{counter:uml}",svg]
....
@startuml
' ヘッダー・フッターを読み込み & スタイル定義
skinparam Shadowing false
' タイトル
title ノート(メモの使い方)
/'単純なノート
他の要素に直接繋げない場合、名前を付ける必要があるので注意
'/
note "単純なノート" as sinmpeNote
' 複雑なノート
note as complexNote
複雑なノート
改行するとそのまま改行される
===
' ===で二重線を引くことができる
- <b>太文字</b>
- **「*」も使える**
- <u>アンダーライン</u>
- __「_」も使える__
- ~~「~」で波線も使える~~
- <i>斜字体</i>
- //「/」も使える//
- <s>打ち</s> <del>消し</del> <strike>線</strike>
- --「-」も使える--
- <font color="indigo">文字色変更</font>
- <size:11>フォントサイズ変更</size>
- 画像の挿入
---
' ---で境界線を引くことができる
<img https://pbs.twimg.com/profile_images/3228282688/4a3c9e25b9831f3d74c357cae6c90636_reasonably_small.png>
end note
/'エレメントとノートを関連付ける
1. 関連付けるエレメントの直後にnoteを入れる
2. ノートに名前をつけ、線でつなぐ
'/
(上note)
note top: 上にノートをくっつける
(右note)
note right: 右にノートをくっつける
(下note)
note bottom
下にノートをくっつける
複数行もできる
end note
(左note)
note left
左にノートをくっつける
複数行もできる
end note
complexNote ... (右note)
complexNote --- (上note)
(上note) -right-> (右note)
(右note) -down-> (下note)
(下note) -left-> (左note)
(左note) -up-> (上note)
@enduml
....
---
== ワイヤーフレーム
UIみたいなプロトタイプ
[plantuml,"{temp}/{counter:uml}",svg]
....
@startsalt
{+
{* ファイル | 編集 | 表示 | ウィンドウ | ヘルプ}
{/ ブログ記事編集 | 僕的URMのススメ | PlanUML言語 }
{
{ 保存種別: | ^日時を指定して予約投稿^ }
[X] サムネイル画像を変更する
[X] Twitterと連携し、投稿されたらツイートする
[ ] 投稿時にメールを送信する
}
{[Close] | [Cancel] | [保存]}
}
@endsalt
....
== ソルト (ツリー構造)
[plantuml,"{temp}/{counter:uml}",svg]
....
@startsalt
{
{T
+ World
++ America
+++ Canada
+++ USA
++++ New York
++++ Boston
+++ Mexico
++ Europe
+++ Italy
+++ Germany
++++ Berlin
++ Africa
}
}
@endsalt
....
== マインドマップ
[plantuml,"{temp}/{counter:uml}",svg,title="title"]
....
@startmindmap
' ヘッダー・フッターを読み込み & スタイル定義ファイル読み込み
title マインドマップ
* <&star>星のカービィ
** サウンド
*** ボイス
****_ 大本 眞基子(カービィ他)
****_ 桜井 政博(デデデ 64, スマブラ)
****_ 緒方 賢一(デデデ アニメ)
****_ 熊崎 信也(デデデ USD, Wii, トリデラ)
****_ 私市 淳(メタナイト)
****_ 齋藤 彩夏(ワドルディ)
*** 効果音
****_ 安藤浩和
****_ 石川淳
****_ 小笠原雄太
*** 音楽
****_ 安藤浩和
****_ 石川淳
****_ 小笠原雄太
** テキスト
*** システムメッセージ
****_ 子供向け
****_ 伏線を張りまくる
****_ ネタを作る
*** ナレーション
****_ 毛糸のカービィのみナレーションあり
****_ 津賀 有子
*** セリフ
****_ 備えあれば嬉しいな!
****_ 才能は無くても根気だけはある物好きは腐るほどいるでゲス
****_ 環境破壊は気持ちいいぞい
** グラフィック
*** 背景
****_ 美しい系のきれい
****_ 違和感がない程度に異常
*** オブジェクト
****_ 限りなく少ない
****_ ワドルディが時々コントしてる
*** カメラワーク
****_ 固定
*****_ 基本2D移動
left side
** 世界観
*** コンテキスト
****_ カービィの周りは平和
****_ なにげにシリーズを通して深い
*** キャラクター
****_ 基本的に可愛らしいビジュアル
*** イベント
****_ ギミック多め
****_ HAL部屋
****_ 裏切り
****_ 敵の敵は味方
*** ストーリー
****_ 可愛らしさ優先
****_ 割とエグい設定
****_ 世界の危機(いつもの)
** システム
*** 自由度
****_ 増え続けるコピー能力
****_ 基本ストーリーをなぞる
****_ 移動に関する自由はほぼ無い
*** 操作性
****_ コピー能力によりコマンド有り
****_ ノーマルの場合は単純明快
*** ゲームバランス
****_ 基本初心者向け
****_ 上級者向けのモードあり
@endmindmap
....
This source diff could not be displayed because it is too large. You can view the blob instead.
// :experimental:
// :lang: ja
// :icons: font
// :sectnums:
// :sectnumlevels: 5
// :experimental:
// :figure-caption: 図
:lang: ja
include::config.adoc[]
:toc: left
// マクロ
// :image-root-dir: ./
// :image-root-dir: ..\
:imagesdir: Images
= AsciiDocのインストールまとめ rev3 [small]#[2020/12/25]#
.[big]#概要#
[%hardbreaks]
AsciiDocの編集及びプレビュー表示を可能にする環境の構築方法について記述する。
情報は、2020/5/18現在のものとする。
== Visual Studio Code上での編集/プレビュー環境構築
=== VSCode自身のインストール
https://code.visualstudio.com/download/[ココ] (VSCodeのサイト) からダウンロード、インストールする。
[title="",caption="",cols="a,2a",frame="none",grid="all"]
|====
|
// 左
image::UserOrSystem.png[VSCode Installer, 58%]
|
// 右
ダウンロードページには、User InstallerとSystem Installerとが用意されているが、それぞれ以下の通り。
- User Installer:そのユーザーのみにインストール
- System Installer:全ユーザーにインストール(管理者権限が必要)
どちらを選んでもアプリケーションそのものの違いはない。
|====
=== 拡張機能のインストール
==== AsciiDoc
VSCodeにAsciiDoc拡張機能をインストールする。
. kbd:[Control+Shift+X] を押下 (または下図左下のアイコンをクリック)
. 拡張機能の検索窓に *AsciiDoc* と入力
. 下図のアイコンのAsciiDocを選択して *Install* をクリック
image::instAsciiDocExtend.JPG[instExtADoc,title=AsciiDoc拡張, 50%]
==== VSCodeの日本語化 (※任意)
VSCodeのメニューを日本語にする。AsciiDocに直接の関係はないので任意。
. kbd:[Control+Shift+X] を押下
. 拡張機能の検索窓に *Japanese* と入力
. "Japanese Language Pack for Visual Studio Code"(発行者:Microsoft) を選択して *Install* をクリック
=== 初期設定の変更箇所
[%hardbreaks]
AsciiDocの初期パラメータを調整する。
※日本語化していたら、適宜読み替えのこと。
* kbd:[Control + ,] を押下 (または、メニューからmenu:File[Preference,Setting]を選択)
* `Search Strings` に `AsciiDoc` と入力。AsciiDoc関連のパラメータが表示されるので以下のパラメータを変更
. menu:asciidoc[preview: Use Editor Style]: チェックOFF (プレビューの背景を白)
. menu:asciidoc[Use_kroki]: チェックON(UML図が描画できる、ただし外部サーバーに接続される)
. menu:asciidoc[Use_asciidoctor_js]: チェックON
. menu:asciidoc[Use_asciidoctorpdf]: チェックOFF
* 本設定を行ったタブを閉じた後、VSCodeを再起動
[[check_vs]]
=== 確認方法
添付の `SampleADocAndUML.adoc` のプレビュー表示結果が `SampleADocAndUML.html` の表示出力結果と(ほぼ)同じかどうか確認する。 +
プレビューは、VSCodeで``SampleADocAndUML.adoc``を開いた後、『kbd:[Cntl+K]、 kbd:[Cntl]を離してkbd:[V]』または『ウインドウ右上のアイコンimage:IconPreview.png[IconPreview]を押下』すると、右側に表示される。
== Chrome上でのプレビュー環境構築
=== 拡張機能のインストール
ChromeにAsciiDoc拡張機能(Asciidoctor.js Live Preview)をインストールする。
. https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia[Asciidoctor.js Live Preview] を開く
. btn:[chromeに追加] ボタンを選択
. menu:Chromeのウィンドウ[その他のツール(右上の縦3点リーダ),拡張機能]を選択
. btn:[Asciidoctor.js Live Preview]の kbd:[詳細]を選択。OFFならONに変更
. ファイルURLへのアクセスを許可するをkbd:[有効]に
+
image::instChromeAsciiDoc.JPG[a,align=center, 50%]
. kbd:[拡張機能のオプション]を選択して以下を設定
[number]
.. toc=left (目次を右につける)
.. Enable the diagrams extension (UMLを使う)
+
image::ex1.JPG[a, align=center, 50%]
image::ex2.JPG[a, align=center, 50%]
=== 確認方法
添付の `SampleADocAndUML.adoc` をChrome上にドラッグ&ドロップして表示されるプレビュー結果が `SampleADocAndUML.html` の表示出力結果と(ほぼ)同じかどうか確認する。
== 別形式でのファイル出力
=== HTML出力
開いている$$.$$adocファイルと同じフォルダに、同名の$$.$$htmlファイルとして保存する。上書き保存されるので注意。
. $$.$$adocファイルを開く
. kbd:[Control+Shift+p]を押下
. $$>$$ の横に "AsciiDoc: Save HTML document" と入力、kbd:[Enter]を押下
== その他
詳細は割愛した事項を以下に記す。
=== PDF出力
AsciiDoctorが必要。また、AsciiDoctorをインストールするには、Rubyが必要 (gemパッケージとして配布されているため)。
- AsciiDoctorをインストールするには、Rubyをインストールした後、以下のコマンドでOK。 +
gem install asciidoctor
gem install asciidoctor-pdf
- 出力するには、VSCodeの設定で menu:asciidoc[Use_asciidoctorpdf]: false とした後、kbd:[Control+Shift+p] → "AsciiDoc: Export document as PDF" とすれば保存できる。
ただし、日本語が化けるので、default-themes.yml にフォントの情報を追記しなければならない。
=== PlantUML
VSCodeの拡張機能における設定で、menu:asciidoc[use_kroki]: true とした場合、
PlantUMLの記述を行うと、レンダリングのため https://kroki.io にアクセスしてしまう。そのため、外部に漏れてはいけないUML図を記述できない。
ローカルでレンダリングする(外部に接続しないようにする)には、次のようにすればよい。
- asciidoctor-diagramをインストール。
gem install asciidoctor-diagram
- VSCodeの設定を次のように変更。
"asciidoc.asciidoctor_command":"asciidoctor -r asciidoctor-diagram"
"asciidoc.use_asciidoctor_js": false
ただし、これだと$$.adoc$$と同じ場所に画像ファイルが沢山できてしまうので、
[source,json]
....
"asciidoctor -r asciidoctor-diagram -a outdir=.asciidoctor -a imagesdir=.asciidoctor -a imagesoutdir=.asciidoctor"
....
のようにしておくとよい。
また、諸々のUML図を描画するなら、おそらく Graphviz のインストールも必要。
以上
This source diff could not be displayed because it is too large. You can view the blob instead.
////
[コメント開始]
各種事前定義 ここでは最低限必要なものだけ定義、一覧説明をコメントブロックで記載しておく
定義が不要なら、//でコメントアウト、adoc毎に!(びっくりマーク)を追加すればよい
例. :sectnums!:
[コメント終了]
////
//-----------------------------------------------------------------------------------------------------
// 事前定義
:doctype: article
:toclevels: 3
:sectnums:
:sectnumlevels: 4
:sectlinks:
:icons: font
//[イメージのパスを指定]
:imagesdir: Images
// :lang: ja
ifeval::[{lang} == ja]
:toc-title: 目次
:example-caption: 例
:table-caption: 表
:figure-caption: 図
:preface-title: はじめに/まえがき
:appendix-caption: 付録
:caution-caption: 注意
:important-caption: 重要
:last-update-label: 最終更新
:listing-caption: リスト
:manname-title: 名前
:note-caption: 注記
:warning-caption: 警告
:tip-caption: ヒント
:untitled-label: 無題
:version-label: バージョン
endif::[]
// HTML出力で画像を埋め込む
:data-uri:
// 各種Macro拡張
:experimental:
////
#### COMENT START #################
------------------------------------------------------------------
[ドキュメント毎に設定すべきもの]
:toc: left
:source-highlighter: coderay
:docname: = asciidoc
:author: my name
:revnumber: 0.9
:revdate: 2019/12/1
* 意味が不明なものは以下を参照
https://takumon.github.io/asciidoc-syntax-quick-reference-japanese-translation/
[属性定義]
:experimental: *各種マクロ拡張時に定義しておく
::module: *モジュール名
:Author: *著者名
:Email: *メールアドレス
:Date: *日付(2020/01/20)
:Revision: Rev.1 * リビジョン指定
:lang: ja * 言語指定
:doctype: book * 言語の種類(ja,...)
:description: * 説明???
:docname: ドキュメント名 * ドキュメント説明
[イメージのパスを指定]
:imagesdir: ./_images
[ソースハイライト]
:source-highlighter: coderay
[見出し設定]
:sectnums:
セクションに番号On, Offのときはコメントアウトもしくは"!""
[キャプチャーのラベル、不要なときは、空指定]
:chapter-label:
[目次作成]
:toc: left
目次 left,right,macro macroの場合は挿入箇所でtoc::[]を記述する
[目次のタイトル]
:toc-title:
[目次 階層レベル]
:toclevels: 3
[各ラベルの日本語設定]
:preface-title: はじめに/まえがき
:appendix-caption: 付録
:caution-caption: 注意
:example-caption: 例
:figure-caption: 図
:important-caption: 重要
:last-update-label: 最終更新
:listing-caption: リスト
:manname-title: 名前
:note-caption: 注記
:toc-title: 目次
:table-caption: 表
:warning-caption: 警告
:tip-caption: ヒント
:untitled-label: 無題
:version-label: バージョン
#### COMENT END #################
////
\ No newline at end of file

:lang: ja
include::config.adoc[]
// custom css.
//:stylesdir: ./
//:stylesheet: edit.css
//:toc: left
//:imagesdir: Images
:hardbreaks:
= t =
== 第1章
最初の文書です。
* [x] チェックボックス [*] or [ ]
== 第2章
ほげ
以上
This diff is collapsed.
////
[コメント開始]
各種事前定義 ここでは最低限必要なものだけ定義、一覧説明をコメントブロックで記載しておく
定義が不要なら、//でコメントアウト、adoc毎に!(びっくりマーク)を追加すればよい
例. :sectnums!:
[コメント終了]
////
//-----------------------------------------------------------------------------------------------------
// 事前定義
:doctype: article
:toclevels: 3
:sectnums:
:sectnumlevels: 4
:sectlinks:
:icons: font
//[イメージのパスを指定]
:imagesdir: Images
// :lang: ja
ifeval::[{lang} == ja]
:toc-title: 目次
:example-caption: 例
:table-caption: 表
:figure-caption: 図
:preface-title: はじめに/まえがき
:appendix-caption: 付録
:caution-caption: 注意
:important-caption: 重要
:last-update-label: 最終更新
:listing-caption: リスト
:manname-title: 名前
:note-caption: 注記
:warning-caption: 警告
:tip-caption: ヒント
:untitled-label: 無題
:version-label: バージョン
endif::[]
// HTML出力で画像を埋め込む
:data-uri:
// 各種Macro拡張
:experimental:
////
#### COMENT START #################
------------------------------------------------------------------
[ドキュメント毎に設定すべきもの]
:toc: left
:source-highlighter: coderay
:docname: = asciidoc
:author: my name
:revnumber: 0.9
:revdate: 2019/12/1
* 意味が不明なものは以下を参照
https://takumon.github.io/asciidoc-syntax-quick-reference-japanese-translation/
[属性定義]
:experimental: *各種マクロ拡張時に定義しておく
::module: *モジュール名
:Author: *著者名
:Email: *メールアドレス
:Date: *日付(2020/01/20)
:Revision: Rev.1 * リビジョン指定
:lang: ja * 言語指定
:doctype: book * 言語の種類(ja,...)
:description: * 説明???
:docname: ドキュメント名 * ドキュメント説明
[イメージのパスを指定]
:imagesdir: ./_images
[ソースハイライト]
:source-highlighter: coderay
[見出し設定]
:sectnums:
セクションに番号On, Offのときはコメントアウトもしくは"!""
[キャプチャーのラベル、不要なときは、空指定]
:chapter-label:
[目次作成]
:toc: left
目次 left,right,macro macroの場合は挿入箇所でtoc::[]を記述する
[目次のタイトル]
:toc-title:
[目次 階層レベル]
:toclevels: 3
[各ラベルの日本語設定]
:preface-title: はじめに/まえがき
:appendix-caption: 付録
:caution-caption: 注意
:example-caption: 例
:figure-caption: 図
:important-caption: 重要
:last-update-label: 最終更新
:listing-caption: リスト
:manname-title: 名前
:note-caption: 注記
:toc-title: 目次
:table-caption: 表
:warning-caption: 警告
:tip-caption: ヒント
:untitled-label: 無題
:version-label: バージョン
#### COMENT END #################
////
\ No newline at end of file
:experimental:
:lang: ja
:icons: font
:sectnums:
:sectnumlevels: 5
:experimental:
:toc: left
:figure-caption: 図
:toc-title: 目次
= AsciiDoc関連で出来そうなこと [.small]#(2020/05/26)#
以下、できそうなことをリストアップします。内容の粒度はまちまちですがご容赦ください。
== adocファイルをpushしたときにpdf/htmlファイルを自動生成
以下のサイトを参考にして $$.gitlab-ci.yml$$ を記述(CI/CDを設定)すればできるかもしれない。
https://blog.koyama.me/archives/1579[asciidocで書いた履歴書をGitLabのCIで自動ビルド]::
これが一番近そう。おそらく、Dockerのimageに https://github.com/htakeuchi/docker-asciidoctor-jp[htakeuchi/docker-asciidoctor-jp] を指定しているのがポイント。
https://tech-blog.cloud-config.jp/2020-03-26-github-actions-asciidoc1/[GitHub Actionsを使って気軽にAsciiDocを出力しよう(1)]::
GitHubなので少し違うかも。
https://github.com/manumilou/gitlab-ci-example-asciidoc/blob/master/.gitlab-ci.yml[manumilou/gitlab-ci-example-asciidoc]::
imageが指定されていない。動くのだろうか。
== ローカルでUML図を描画
PlantUML Serverをローカルに構築すれば、外部サーバーに接続することなくUMLのプレビューが表示できる…と思ったが、AsciiDocの拡張機能には、PlantUMLのサーバーを指定する設定がない模様。 +
なお、以下を参考にすれば、PlantUML Serverの構築まではスムーズにできる(Windows10Proで確認済)。あとはサーバーを指定するだけなのだが...
参考:
https://dev.classmethod.jp/articles/plantuml-server-on-docker/[UMLの爆速プレビュー環境をVisual Studio Code + PlantUML Server on Dockerで簡単に構築する]
== 表のセル中の揃え (上/中/下, 右/中/下)
これはできる。col属性で指定する。(水平方向)$$.$$(垂直方向)。 +
水平方向::
< が 左、^ が 中、> が 右
垂直方向::
< が 上、^ が 中、> が 下
以下の表は、$$[cols="<.^, >.<, ^.>"]$$ すなわち「左/中揃え」「右/上揃え」「中/下揃え」として指定した例。効いているかどうかわかりにくい部分もあるが。
[cols="<.^ ,>.<, ^.>"]
|===
| 1111111111
111111111
11111111111
| 2222222222
2222222222222
22222222222
22222222222
| 3333333
3333
3333333
333333333
33
3
3
| Cell 1
| Cell 2
| Cell 3
|===
以上
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment