From a623a641bc4a3a00309561181edcd2a1ad7fec33 Mon Sep 17 00:00:00 2001 From: matsuo Date: Wed, 27 Nov 2024 09:15:23 +0900 Subject: [PATCH] =?UTF-8?q?getAdoc.bat:=20html=E3=83=98=E3=83=AB=E3=83=97?= =?UTF-8?q?=E3=81=A8=E3=80=81drawio=E3=83=95=E3=82=A1=E3=82=A4=E3=83=AB?= =?UTF-8?q?=E3=82=B3=E3=83=94=E3=83=BC=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...\230\223\350\252\254\346\230\216help.adoc" | 1360 +++++++ ...\230\223\350\252\254\346\230\216help.html" | 3295 +++++++++++++++++ .../getADoc.Data/adocTPL/HtmlHelp/config.adoc | 344 ++ .../adocTPL/ReadMe/ReadMeAsciiDocTool.adoc | 58 +- .../adocTPL/ReadMe/ReadMeAsciiDocTool.html | 407 +- .../adocTPL/drawio_base/fig.drawio | 18 + Release/getADoc.Data/getADoc.bat | 53 +- 7 files changed, 5398 insertions(+), 137 deletions(-) create mode 100644 "Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.adoc" create mode 100644 "Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.html" create mode 100644 Release/getADoc.Data/adocTPL/HtmlHelp/config.adoc create mode 100644 Release/getADoc.Data/adocTPL/drawio_base/fig.drawio diff --git "a/Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.adoc" "b/Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.adoc" new file mode 100644 index 0000000..8187a01 --- /dev/null +++ "b/Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.adoc" @@ -0,0 +1,1360 @@ += Asciidoc help(表現を試す) +// If disable,set "!" : ":key: " -> ":!key: ". +:lang: ja +:doctype: book +:toc: left +:toclevels: 3 +:sectnums: +:sectnumlevels: 4 +:sectlinks: +:FreePage: +:!CustomIcon: ja +:UserConfigEnd: +include::config.adoc[] + +{HeadLine} + +== はじめに + +AsciiDocの記述方法でよくつかうものを記載します。さらに多くの記述を使いたい場合は以下を参照してください。 + +* https://takumon.github.io/asciidoc-syntax-quick-reference-japanese-translation/[Asciidoctor 文法クイックリファレンス(日本語訳)] + +* https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/[Asciidoctor 文法クイックリファレンス(原文)] + +* https://docs.asciidoctor.org/home/[ユーザーマニュアル(英語)] + +// * https://asciidoctor.org/docs/user-manual/[ユーザーマニュアル(英語)] + +* https://qiita.com/hbsnow/items/88e1414ac97501af17ff[ Qiita 細かい設定がよくわかる！] + +* https://asciidoctor.org/docs/user-manual/#builtin-attributes[ビルドインアトリビュートの一覧] + +--- + +その他:: +* https://blog.mrhaki.com/2016/10/awesome-asciidoctor-highlight-lines-in.html[Awesome Asciidoctor: Highlight Lines In Source Code Listings - Messages from mrhaki ★さまざまな便利な情報★] + + +== コメント類 +コメント部分は、最終出力から除外されます +---- + // :行頭でその行はコメントになる + ////から//// :ブロック内がすべてコメント +---- + +== 文字飾り + +.基本 +$$`*_`$$でサンドイッチすることで表現。空白含む場合は $$**単語A 単語B**$$ の様に２個ずつつけるとよい +// =============================== +[cols="1a,2l", options="header"] +|=== +^| 結果 ^| 記述 +| +[%hardbreaks] +*太字の語句* +_イタリック_ +*_太字のイタリック_* +`モノスペース` +| +*太字の語句* +_イタリック_ +*_太字のイタリック_* +`モノスペース` +|=== + +.少し拡張(アンダーラインなど) +// =============================== +[cols="2a,3l", options="header"] +|=== +^| 結果 ^| 記述 +| +[%hardbreaks] +[.underline]#アンダーライン# +通常文字 vs [.small]#小さい文字# vs [.big]#大きい文字# + +[.line-through]#取り消し線# +| +[.underline]#アンダーライン# +通常文字 vs [.small]#小さい文字# vs [.big]#大きい文字# + +[.line-through]#取り消し線# +|=== + +== 見た目(ボタンとアイコン) +// チェックボックス 文書定義 +:cboxOn: pass:normal[``{startsb}✔{endsb}``] +:cboxOff: pass:normal[``{startsb}{nbsp}{endsb}``] +// チェックボックス GUI定義 +:cboxgOn: kbd:[✔] +:cboxgOff: kbd:[{nbsp}] + + + +// [cols="1l,2a", options="header"] +[cols="l,a", options="header"] +[%autowidth] +|=== +| 記述 | 説明 +|kbd:[Ctrl+C] | kbd:[Ctrl+C], kbd:[Ctrl+Shift+V] +|btn:[ボタン] | btn:[ボタン],btn:[ OK ],btn:[ CANCEL ]など +|{cboxOn}/{cboxOff} | {cboxOn}/{cboxOff} 以下の事前マクロ定義必要 + + ``$$ :cboxOn: pass:normal[``{startsb}✔{endsb}``] $$ `` + + ``$$ :cboxOff: pass:normal[``{startsb}{nbsp}{endsb}``] $$ `` +|{cboxgOn}/{cboxgOff} | {cboxgOn}/{cboxgOff} 以下の事前マクロ定義必要 + + ``$$ :cboxgOn: kbd:[✔] $$`` + + ``$$ :cboxgOff: kbd:[{nbsp}] $$`` + +|menu:ファイル[保存] | + +[%hardbreaks] +menu:ファイル[保存] + +階層化$$:$$``>``でサブメニュー化:: + $$menu:ファイル[保存 > Sub > A]$$ + + -> + menu:ファイル[保存 > Sub > A] + +a| +$${OK}$$ +| +:OK: pass:[😀 ] +[%hardbreaks] +事前に定義 +``$$:OK: pass:[😀 ]$$`` +{ok} +https://www.asahi-net.or.jp/~ax2s-kmtn/ref/unicode/u1f600.html[アイコンはユニコードで色々定義,Unicodeの絵文字] +😍(``$$😍$$``)、🙅(``$$🙅$$``)、🌈(``$$🌈$$``) などなど +|=== + +== セクション（章節） == +``=␣<セクション>``で始める行がセクションになる。セクションの区切りには空白行が必要。$$=$$の数でセクションレベルが決まる + +---- += ドキュメントのタイトル +== 章最初のタイトル +=== 節のタイトル +==== 文節のタイトル +===== さらにその下タイトル +====== さらにさらにタイトル +== 章次のタイトル +---- + +//// +以下は箇条書きのほう +["arabic"] +. 階層番号番号 +["decimal"] + .. サブ +["arabic"] + ... サブサブ + ... サブサブ +. 階層番号番号 +. 階層番号番号 +//// + +== 箇条書き == +* ``*␣<項目>``、``-␣<項目>``で始める。異なる記号を使えば、階層的に表現できる +* 形状変更は``[square]``,``[circle]``,``[disc]``を指定 +[] +* チェックボックスは``\*␣[ ]␣ <項目>``。 []の中に``[x]`` or ``[*]`` or ``[ ]`` +* 箇条書きブロックを区切るには ``空行`` + ``//-`` + ``空行``をいれる。もしくは``空行`` + ``[]``。 + +//- + + +.箇条書き(項目) +// =============================== +[cols="a,l", options="header"] +|=== +^| 結果 ^| 記述 +| + - 項目1 + * サブ項目1 + * サブ項目2 ++ +-- +サブ項目の中に複数行に渡る大きな大きなブロックを記述できる +-- +- 項目2 + +// 左 +| +- 項目1 + * サブ項目1 + * サブ項目2 ++ +-- +サブ項目の中に複数行に渡る大きな大きな大きな +ブロックを記述できる +-- +- 項目2 +| +.形状変更 +[square] +* square + +[circle] +* circle + +[disc] +* disc + +[none] +* none bullet +// 左 +| +.形状変更 +[square] +* square + +[circle] +* circle + +[disc] +* disc + +[none] +* none bullet + +| +.チェックボックス +* [*] checked +* [x] also checked +* [ ] not checked +* no symbol marks + +// 左 +| +.チェックボックス +* [*] checked +* [x] also checked +* [ ] not checked +* no symbol marks +|=== + +// =============================== + +== 箇条書き（数字） == +[%hardbreaks] +``.␣<項目>``（ピリオド）で始める。階層構造は``...␣``と連ねる。 +番号は[arabic]/[decimal]/[loweralpha]/[upperroman]などで階層ごとに指定 + +.箇条書き(数字) +[%hardbreaks] + +// =============================== +[cols="a,a", options="header"] +|=== +^| 結果 ^| 記述 +| +. 項目1 ++ +[caption=""] +.項目1のタイトル +-- +サブ項目の中にブロックを記述できる +-- + .. サブ項目1 + .. サブ項目2 +[decimal] + ... サブサブ1 + ... サブサブ2 ++ +//"例"を削除 +// [caption=""] +// .テストタイトル +-- +サブ項目の中にブロックを記述できる +-- + +. 項目2 + +| +.... +. 項目1 ++ +-- +サブ項目の中にブロックを記述できる +-- + .. サブ項目1 + .. サブ項目2 +[decimal] + ... サブサブ1 + ... サブサブ2 + ++ +-- +サブ項目の中にブロックを記述できる +-- +.... + +|=== +// =============================== + +== ラベル == +* <ラベル名>$$::$$(後ろのコロン２つ）でラベルをつける。コロンを増やせば階層化できる。 +* $$[horizontal]$$指定で一行目から、行が開始される + +.ラベル +// =============================== +[cols="a,a", options="header"] +|=== +^| 結果 ^| 記述 +| +第一項:: + 第一項の定義 + さらにそのサブ::: + サブの内容 +| +.... +第一項:: + 第一項の定義 + さらにそのサブ::: + サブの内容 +.... + +|=== +// ============================== + + + +== ブロックラベル == +``.ブロックラベル``(ドット）でラベルをつける。スペースは不要。箇条書き（数字）になってしまう。 + + +:source-highlighter: coderay + +== ブロック == +* 以下の記号４文字のキーワード行で囲む。それぞれ動作、意味が異なる +* {ddollar}～ {ddollar}で囲むとパスされる →　<<_エスケープ方法>> + +//[%autowidth.stretch] +[cols="1,1,4,20"] +|===================================================================================== +|1|`--` |(ハイフンx2) |オープンブロック。 [red]##**汎用ブロック**##。オープンブロックはpassとtableを除き、他のブロックとして機能できます。 +|2|`----` |(ハイフンx4) |コードブロック。コードもしくはファイルの表示(リスティング) +|3|`$$....$$` |(ドット) |リテラルブロック。書いたままに表示させたいとき。 +|4|`====` |(イコール) |サンプルブロック。 通常で枠ができるフォーマット。#[caption="キャプション名"]で制御。``=`` のみで、ナンバリングもキャプションも除去される様子# +|5|`$$++++$$` |(プラス) |インラインブロック。変換せずにHTML出力,パススルー/インライン,バックエンドのマークアップの書式を記述する +|6|`$$****$$` |(アスタ) |サイドバーブロック +|7|`$$____$$` |(アンダーバー) |ブロッククウォート（引用かな?） +|===================================================================================== + +コードブロックに指定できる言語:: ++ +==== +``C,C++,HTML,Python,Ruby,JavaScript,JSON,Java,XML,YAML +,Clojure,CSS,Delphi,diff,ERB,Go,Groovy,HAML,Lua +,PHP,Sass,SQL,Taskpaper`` +==== + +コードブロックで改行禁止[red]##New##:: + ++ +---- + .CodeBlock + [%nowrap] + ---- + .... + ---- +---- +// =============================== +[cols="a,a", options="header"] +|=== +^| 結果 ^| 記述 +| +[source,JavaScript] +.JavaScript例（タイトル） +---- +var a = "test"; +echo(a,b); +---- +| +.... + [source,JavaScript] + .JavaScript例（タイトル） + ---- + var a = "test"; + echo(a,b); + ---- +.... + +|=== + +コードブロックの属性変更:: +リテラルなブロックでもマクロなどが利用可能にできます。 +//[subs="verbatim,specialchars,callouts,attributes,replacements,macros,quotes,macros"] +// [subs="normal,-post_replacements"] + ++ +// [subs="normal,-post_replacements"] +---- + ---- + ##hoge## + ---- +---- + +→ +[subs="normal,-post_replacements"] +---- + [subs="normal,-post_replacements"] + ---- + ##hoge## + ---- + + これでもよい：[subs="verbatim,specialchars,callouts,attributes,replacements,macros,quotes"] + +---- + +== 警告、重要、情報などのアイコン +適用するには属性 ``:icons: font``が必要 +// =============================== +[cols="a,a", options="header"] +[%autowidth] +|=== +^| 結果 ^| 記述 +| +NOTE: ノート(NOTE) + +WARNING: 警告(WARNING) + +IMPORTANT: 重要(IMPORTANT) + +TIP: チップス(TIP) + +CAUTION: 注意(CAUTION) +| +.... +NOTE,WARNING,IMPORTANT,TIP,CAUTION + +単行の場合: + +NOTE: <内容> + +ブロックの場合: (サンプルブロックを使う) + +[NOTE] +==== +<内容> +==== +.... + +|=== + +.■カスタムアイコンの利用方法 +[%hardbreaks] +PNGもしくはSVGデータとしてこれらのアイコンを変更することができます。iconsフォルダにファイル名"NOTE,WARNING,IMPORTANT,TIP,CAUTION"で、拡張子を``.svg``もしくは``.png``のファイルを配置すればよい。 + +.アイコンの属性を変更 +[cols="l,a"] +[%autowidth] +|=== +|:icons: image| アイコンのタイプをイメージに変更 +|:iconsdir: ./icons | アイコンの配置場所をiconsに変更（未設定だと\{imagesdir}/icons) +|:icontype: svg | 画像の種類を指定 svg or png +|=== +IMPORTANT: 属性変更はファイルの先頭がよい。途中で切り換えるとうまくいかない場合があった。 + +// [horizontal] +※その他方法:: 以下でも一時的に変更することも可能。拡張子は``:icontype: xxx``と同じなら [underline]##拡張子を省略可能##です ++ +==== +[%hardbreaks] +$$[NOTE, $$ [red]##icon=NoteCustom.svg## ] +$$====$$ +$$カスタムNOTEアイコン$$ +$$====$$ +==== + +// =============================== + +== 区切り線 == +``---``（ハイフン）3個のみ。 + +.区切り線 +// =============================== +[cols="a,a", options="header"] +|=== +^| 結果 ^| 記述 +| +--- +| +``---`` +|=== + +// =============================== + +== 改行 + +[%hardbreaks] +* ``␣+``で繋ぐ。 +* もしくは``[%hardbreaks]``で段落全体で改行を有効にする（段落毎にリセットされる）。 + ドキュメント全体で設定するなら``:hardbreaks:``属性をつけるとよい。個別の解除は\{set:hardbreaks\!}。 + +* [red]#New!# ``$$[.nw]##... hoge hoge ...##$$``で自動改行を抑制かつ複数空白記述可能。別名:``.nowarp`` + 表のセル幅が狭く、改行される場合に、ヘッダ行に指定することでヘッダ行の幅でセル幅を抑制できる。(結構有効)。 + +[IMPORTANT] +==== +[%hardbreaks] +config.adocのインクルード後、属性設定の後、表題の直前に``{ExtendStyle}``を記述すること。 +``toc: left``の前に定義すると目次が表示されなくなります。 +==== + +* [red]#Obsolete!# ``$${NoWrap}$$... hoge hoge ...$${End}$$``で自動改行を抑制 ##前記のものがあるのでもう使わないこと## + +表のセル幅が狭く改行される場合に、ヘッダ行に指定することでヘッダ行の幅でセル幅を抑制できる。 ++ +---- + // Macro + :NoWrap: pass:[] + :Wrap: pass:[] + :End: pass:[] +---- + +.改行 +// =============================== +[cols="1a,2l", options="header"] +|=== +^| 結果 ^| 記述 +| +１行目 + +２行目 +| +１行目 + +２行目 +|=== +// =============================== + +== 段落 揃え == +[%hardbreaks] +* ``[.text-left]``,``[.text-right]``,``[.text-center]``で調整する +* ``[.text-justify]``はよくわからない +* ``[align=xxxx]``、 xxxx=left,center,right,...でもよい + + +// =============================== +[cols="1a,2l", options="header"] +|=== +^| 結果 ^| 記述 +| +[.text-right] +右寄せ +[.text-center] +センター +[.text-left] +左 + +行内で部分的右 [.right]##[右]## +| +[.text-right] +右寄せ +[.text-center] +センター +[.text-left] +左 +行内で部分的右 [.right]##[右]## +|=== +// =============================== + +[.text-right] +This paragraph is aligned right + +[.text-center] +This paragraph is aligned center + +[.text-left] +This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. + +[.text-justified] +This paragraph is justified, which is the default.This paragraph is justified, which is the default.This paragraph is justified, which is the default.This paragraph is justified, which is the default. + +== コメント == +.... +// コメント行 + +//// + コメントブロック +//// +.... + +== エスケープ方法 == + +[cols="^1a,3a",options="header"] +|========= +|記述 |表現 +|{ddollar} ～ {ddollar}で囲む |通常文字になる +|$$+++～+++$$で囲む |HTML制御になる(インライン要素) +|$$pass:[～]$$で囲む |HTML制御になる(インライン要素、同上） +|{backslash}(backslash) |次の文字の制御のみキャンセル。{backslash}$$*bold*$$や{backslash}$${lt}$$など +2+<| ※ その他は<<_特殊記号>>で記載すること。 +|========= + +== 特殊記号 == + +特殊記号は``{}``を使う。もしくは``$$&#<10進数>;$$`` or ``$$&#x<10進数>;$$``など。 + +.特殊記号の一覧 +[cols="^1a,3a",options="header",caption=] +|========= +|記号{nbsp}{nbsp}{nbsp} pass:[* ({}で囲む)] |表現 +|dollar | $(ドル):{sp}{sp}$$$ or $$$ + +※これは存在しないので、自身で``$$:dollar: $$$``を定義すること +|sp | ``$$ $$ `` スペース１文字 +|nbsp | ノンブランクスペース文字 +|zwsp | 幅無スペース +|quot | ``$$"$$`` (ダブルクウォート) +|apos | ``' ``(アポストロフィー} +|backtick| ``{backtick}`` (バッククウォート) +|lsquo | ``‘``(開始シングルクウォート) +|rsquo | ``’``(終了シングルクウォート) +|ldquo | ``“``(開始ダブルクウォート) +|rdquo | ``”``(終了ダブルクウォート) +|deg | ``°``(角度) +|plus | ``+``(プラス) +|brvbar | ``¦`` +|vbar | ``{vbar}``(論理和) +|amp | ``&`` (アンパサンド) +|lt | ``<`` (smaller than) +|gt | ``>`` (gretar than) +|startsb | ``[`` (開始カギカッコ） +|endsb | ``]`` (終了カギカッコ) +|caret | ``^`` (キャレット) +|asterisk | ``*`` (アスタリスク) +|tilde | ``~`` (チルダ) +|backslash | ``\`` (バックスラッシュ) +|two-colons | ``::`` (2つのコロン) +|two-semicolons | ``;;`` (2つのセミコロン) +|cpp | ``C++`` (C++?) +|wj | +|blank | +|empty | +|========= + +== 色 == + +``$$[色 色-background]#コンテンツ#$$``で指定する + +==== +[red yellow-background]#赤いコンテンツ、黄色の背景# <- ``$$[red yellow-background]## 赤いコンテンツ、黄色の背景 ##$$`` +==== + +* 色名の一覧はwikiのWebColor一覧から取れる ++ +-- +[%hardbreaks] +https://en.wikipedia.org/wiki/Web_colors#HTML_color_names[HTML color names] +この内の基本の16種の色のみ定義されている +-- +**asciidoctor-pdf**は以下の定義みたい(rubyの中):: + link:c:\Ruby24\lib\ruby\gems\2.4.0\gems\asciidoctor-2.0.10\data\stylesheets[] + + asciidoctor-default.css + +**vs-codeプラグイン**は以下:: + %USERPROFILE%\.vscode\extensions\asciidoctor.asciidoctor-vscode-2.8.3\media\ + + asciidoctor-default.css + +一覧:: ++ +[cols="a,a,a" align="center"] +|=== +[%hardbreaks] +[aqua]##■■■■■■■## aqua + ``([small]##$$[aqua]##■...■## aqua $$##)`` +|[black]##■■■■■■■## black +|[white gray-background]##■■■■■■■## white +|[fuchsia]##■■■■■■■## fuchsia +|[green]##■■■■■■■## green +|[lime]## ■■■■■■■## lime +|[maroon]## ■■■■■■■## maroon +|[navy]## ■■■■■■■## navy +|[olive]## ■■■■■■■## olive +|[purple]##■■■■■■■## purple +|[red]##■■■■■■■## red +|[silver]## ■■■■■■■## silver +|[teal]## ■■■■■■■## teal +|[yellow]## ■■■■■■■## yellow +|[yellow]## ■■■■■■■## yellow +// [cols="a" options="autowidth" frame="none",grid="all"] +|=== + +※色を拡張したければインラインで定義するか、CSSを拡張するかです。 + +.インラインで拡張 +==== +-- +---- +:SpanRed: pass:[] +// Spanの終了は共通{SpanEnd} +:SpanEnd: pass:[] +---- + +:SpanRed: pass:[] +:SpanEnd: pass:[] +このように定義しておいて + +$${SpanRed} 適当な文字列 {SpanEnd}$$ -> {SpanRed} 適当な文字列 {SpanEnd} +-- +==== + +.CSSで拡張 +==== +未記載 +==== + +:app-name: MyApp^2^ + +[subs="specialchars,attributes,quotes,replacements,macros,post_replacements"] +The application is called {app-name}. + +[%hardbreaks] + +example-caption={example-caption} +figure-caption={figure-caption} + +Red [red]+++`sum_(i=1)\^n i=(n(n+1))/2`$+++ <-AsciiMathML formula + +pass_attribute=pass:attributes,quotes[the '{example-caption}'] +※ passすると[%hardbreaks]などリセットされちゃう +[%hardbreaks] +lang={lang} +menu=menu:File[Save] +keyboad=kbd:[F11] +docdate={docdate} +user-home={user-home} + +== 独自のマクロみたいなの == +[%hardbreaks] +. HTML文法における `id` / `class` 指定の対応 +.... +
+.... +[%hardbreaks] +idは要素そのもののユニークなID、classはCSSの指定でスタイルを指定可能。 +これは以下の２通りで表現可能 +`[#..]` <= ##これでよいと思う## +もしくは +`[[]]` +`[role=" ]` + +.... + [#baz.foo.bar] + ---- + block + ---- +もしくは + [[baz]] + [role="foo bar"] + ---- + block + ---- +.... + +:_ZZ: pass:q[kbd:[abc]] ++++ xabc +++ + + + + +{ZZ} +{_ZZ} + +https://codeday.me/jp/qa/20190609/971327.html[独自のasciidocマクロを定義する方法] +.... +{set:cellbgcolor:gray} +[grid=none, frame=none] +|=== +| X >| Y +|=== +{set:cellbgcolor!} +.... +{set:cellbgcolor:gray} +[grid=none, frame=none] +|=== +| X >| Y +|=== +{set:cellbgcolor!} + +{ +|============= +| +{set:cellbgcolor:#FF0000} +a {cellbgcolor} + +| +{set:cellbgcolor:!} + Cell data +|============= + + + +// =============================== + +== リンク == +WebページなののURLへのリンク。``[リンク表示]`` +Windowsファイルパスの場合は、``\link:[リンク表示]`` +リンク表示名の最後に{caret}（キャレット）を追加すると別ウインドウで開く。{caret}は``[windows=_blank]``の省略表現。 +link:\\santana\Teams\Team-Formstudio\CMM[santanaのCMM] + +.タイトル例 +// =============================== +[cols="1a,2a", options="header"] +|=== + +^| 結果 ^| 記述 +| +https://asciidoctor.org/docs/user-manual/[チートシート英語] +別ウインドウで開く↓ +https://asciidoctor.org/docs/user-manual/[チートシート英語別Window^] +別ウインドウで開く(タイトル無し）↓ +https://asciidoctor.org/docs/user-manual/[^] +| +---- +https://asciidoctor.org/docs/user-manual/[チートシート英語] +別ウインドウで開く↓ +https://asciidoctor.org/docs/user-manual/[チートシート英語別Window^] +別ウインドウで開く(タイトル無し）↓ +https://asciidoctor.org/docs/user-manual/[^] + +---- +|=== + +== イメージリンク == + +* 通常 ++ +---- +image::im.JPG[代替テキスト,x,y,.... align="right/left/center"] + +x,yは表示ピクセル数を指定するか +もしくは%を用いて実際の表示幅からの割合表示が可能 +image::im.JPG[代替テキスト,"50%"] +また明示的に記載も可能(width,height) +image::im.JPG[代替テキスト,width="50%"] + +---- + +* インライン（行内) ++ +---- + image:im.JPG[代替テキスト] +---- + +image::im.JPG[代替テキスト,100,300,align="center"] + +行で　image:im.JPG[代替テキスト,100,300,align="center"]　をいれる + +== テーブル + +=== テーブルの表現 + +.タイトル例 +// =============================== +[cols="a,a", options="header"] +|=== + +^| 結果 ^| 記述 +| +==== +[cols="1a,2a", options="header"] +!========= +!c1!c2 +!data1!data2 +!========= +==== + +| +[source,ascii] +.... +[cols="1a,2a",options="header"] +\|=== +\|c1 \|c2 +\|data1 \|data2 +\|=== +.... +|その他の細かい記述方法| + + +[red]#$$*まだ*$$# + +-- +cols=:: + - 番号で列の幅比率 + - a:adoc書式、l(エル):リテラル書式 +-- +|=== + +NOTE: テーブル内でテーブルを使う場合(Nested Table)は、pass:[|]の代わりにpass:[!](ビックリマーク)を使う。それでも完全で無い。 + +寄せの設定:: ++ +---- +[cols="<,>,^"] +---- ++ +-- +|==== +|1列目: 左寄せ|2列目: 右寄せ|3列目: 中央寄せ +|==== +-- + +寄せの設定2:: ++ +---- +[cols="{左右}.{上下}, {左右}.{上下}, {左右}.{上下}, ..."] +[cols="{左右}.{上下}, {左右}.{上下}, {左右}.{上下}, ..."] + +---- ++ +-- +[cols="<.<3,1"] +|==== +|[cols="<.<,"]は 1列目: 左寄せ + 上寄せ +| +2列目1 + +2列目2 +|==== + +[cols=">.>3,1"] +|==== +|[cols=">.>,"]は 1列目: 右寄せ + 下寄せ +| +2列目1 + +2列目2 +|==== +[cols="^.^3,1"] +|==== +|[cols="\^.^,"]は 1列目: 中央(左右) + 中央寄せ(上下） +| +2列目1 + +2列目2 +|==== +-- + +寄せの設定3:: +---- +行定義|の左側に<,>,^を記述する方法もある。1列ごとに改行して定義する。 +※ヘッダ行とデータ行の間に改行が必要 +|item +<|item +>|item +<.^|item +---- + +##列幅の設定##:: ++ +---- +以下の自動幅autowidth:OK,様々指定方法がある。どれか一つ。 +[options="header,autowidth"] +[options="autowidth"] +[%autowidth] +[%header%autowidth] +["%autowidth",cols="a,a",options="header"] +※ a,100aはadoc2pdf変換で失敗 1:40で失敗,最大39でいけた +---- + + +=== テーブルを段組 + +CAUTION: 「イメージを左、その説明を右」ぐらいの用途。テーブルにテーブルをいれるのが難しいなど、全表現をいれるのに苦労するのでやめたほうがいい。 +[title="テーブルを段組みに使う（2分割）",caption="",cols="a,a",frame="none",grid="all"] +// [frame="none",grid="none"] +|================================ +| +[caption="",title="画像タイトル名",grid="all"] +image::im.JPG[代替テキスト,100,align="center"] + +[caption=""] +.テーブルにテーブルを入れている +[cols="1a,2a", options="header"] +// [frame="none",grid="none"] +!========= +!head a ! head b +!a ! BBBBBB +!========= +| +-- +.これが二つ目のブロックになる +. ラベル +. ラベル +-- +|================================ + +.表現は以下のとおり +.... + [title="ｘｘｘ",caption="",cols="a,a",frame="none",grid="all"] + |================================ + | + // 左段落 + [caption="",title="画像タイトル名",grid="all"] + image::im.JPG[代替テキスト,100,align="center"] + + [caption=""] + .テーブルにテーブルを入れている + [cols="1a,2a", options="header"] + // [frame="none",grid="none"] + !========= + !head a ! head b + !a ! BBBBBB + !========= + + | + // 右段落 + -- + .これが二つ目のブロックになる + . ラベル + . ラベル + -- + |================================ +.... + +=== テーブル 飾り + +``{startsb}cols=...,opts=...,**frame=none,grid=none,stripes=none**]`` + +[cols="a,a",frame=none,grid=none] +[%autowidth] +|=== +|frame: | 表の枠. none: 無し, all: 全枠, ends: 上下のみ, sides:左右のみ +|grid: | セルの枠. none:無し, all:全セル枠, rows:行のみ, cols:列のみ +|[.nw]##stripes:##| ストライプの背景. none:無し, even:偶数行のみ, odd:奇数行のみ, all: すべて,hover: マウス通過時（HTMLのみ) +|=== + +== テキストの折り畳み +$$[%collapsible]$$で記述する +[%hardbreaks] +---- +.タイトル +[%collapsible] +==== +～ ※[%collapsible%open]と指定すると初期状態で展開される +==== +---- +.折り畳みテキスト +[%collapsible%open] +==== +折り畳み内容 +==== + +== インクルード +``include::../../hoge.adoc[]``で別のAsciiDocファイル指定する。 +``[]``内にオプションを指定できる +---- +\include::path[leveloffset=offset,lines=ranges,tag(s)=name(s),indent=depth,opts=optional] +---- +leveloffset= +n:: セクション階層を変更する。＋の数値を指定することで、階層を下げる。マージしたadocのセクション階層と、include先のadocも単独で参照するようなケースに有効です + +== ページサイズ +HTML変換すると、A4サイズに出力されてしまう。ページ幅をウインドウサイズで任意に広がるようにするためには、指定されているCSS(スタイルシート）の``max-width:62.5em;``で固定されています。ページ幅を任意にするために``max-width:``[red]##none;##で 上書きすればよい。 + +.config.docを利用している場合 +================================== +[red]##\{ExtendStyle}の次で\{FreePage}を有効にすればよい。## + + {ExtendStyle} + //{FreePage} -> コメントアウトを外す + // After need empty-one-line + +================================== + +.自分で記述する場合 +================================== +Adocファイルの上の方で、以下の記述を追加すればよい： + + ++++ + + ++++ +================================== + +.参考：変換時に指定されるCSSの記述例 +---- + ... +#header,#content,#footnotes,#footer{width:100%;margin- +left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:。 +9375em} + .... +---- + +== アンカー(内部参照) == + +* 内部参照へのリンクを表現する。 pass:[[[]アンカー名 pass:[]]]で設定し、pass:[<<]アンカー名 pass:[>>]で参照する。設定された直後の章名がアンカー表示名になる。 +* アンカー参照時の表示名を別名にしたいときは、設定箇所でpass:[[[]アンカー名,表示名pass:[]]]とする。 + +* デフォルトで、章は、アンカーが設定されており,pass:[<<_]章名pass:[>>](先頭にアンダーバー)で参照できる。vscodeプレビューは日本語でリンクに飛べなかった？ + +例. +==== +<<_イメージリンク>> +==== + +== 属性設定のサンプル + + += その他 + +. (済)アンカー(内部参照) +. 色名 +. 本 + +== オリジナル先のリンクをしっかりしておこう + +https://asciidoctor.org/docs/[トップページ_Asciidoctor Documentation] + +https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Syntax-quick-ref] + +https://asciidoctor.org/docs/asciidoc-writers-guide/[writers-guide] + +https://asciidoctor.org/docs/asciidoctor-diagram/[diagram] + +https://asciidoctor.org/docs/asciidoc-recommended-practices/[style-guide(draft)] + + +https://www.methods.co.nz/asciidoc/chunked/ch21.html[macro defineがあるんですけどね] + + +//======================================================================================= + += Nested Tables + +https://mrhaki.blogspot.com/2017/04/awesome-asciidoctor-nested-tables.html[Nested tables] + +== Nested tables + +To nest a table in a table we must +use `!` as table separator instead of `|`. +Also the type of the column or cell +must be set to `a` so Asciidoc markup +is processed. + +[cols="1,2a"] +|=== +| Col 1 | Col 2 + +| Cell 1.1 +| Cell 1.2 + +| Cell 2.1 +| Cell 2.2 + +[cols="2,1"] +!=== +! Col1 ! Col2 + +! C11 +! C12 + +!=== + +|=== + +// =============================== 雑 ======================================================================== +MyAp^2^ + +:app-name: pass:q[MyApp^2^] + +{app-name} + +[horizontal] +CPUここが長くなってしまうとどうする:: The brain of the computer. +- a +- b +Hard drive:: Permanent storage for operating system and/or user files. +RAM:: Temporarily stores information the CPU uses during operation. + +[source,text] +==== ++++ +.Q and A +[qanda] +アスキードックとは？:: +ルビーで実装されたドキュメントフォーマットである。 +What is the answer to the Ultimate Question?:: 42 ++++ +==== + +:icons: font + +:tip-caption: 💡 + +[TIP] +It's possible to use Unicode glyphs as admonition icons. +WARNING: It's possible to use Unicode glyphs as admonition icons. + + +:caution-caption: 💡 + +[CAUTION] +It's possible to use Unicode glyphs as admonition icons. +WARNING: It's possible to use Unicode glyphs as admonition icons. + +icon:tags[] ruby, asciidocto + + +[asciimath] +++++ +sqrt(4) = 2 +++++ + + +[stem] +++++ +sqrt(4) +++++ +latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon + + +---- +An open block can be an anonymous container, or it can masquerade as any other block. pass:[dfsa] +---- + +An open block can be an anonymous container, or it can masquerade as any other block. pass:[dfsa] + +{stylesdir} + += まとめ = + + +== タイトル == +``。。。``（。。。） + +.タイトル例 +//=============================== +[cols="a,a", options="header"] +|=== +^| 結果 ^| 記述 +| +<左列のレンダリング結果> +| +---- +<右側列のAsciiDocの記述> +---- +|=== +//=============================== + += 属性関係の設定 = + +脱Word、脱Markdown、asciidocでドキュメント作成する際のアレコレ + +https://qiita.com/tamikura@github/items/5d3f62dae55617ee42bb#htmlのスタイルcssを設定する[HTMLのスタイル(CSS)を設定する] + +.... +// :stylesdir: // どこでも有効になる様子 +//:stylesdir:でCSSのフォルダを:stylesheet:でCSSファイルを指定可能 + +// html-style.adoc +// :stylesdir: stylesheets/ +// :stylesheet: asciidoctor-default.css + +// pdf-style.adoc +// :pdf-style: themes/default-theme.yml + +.... + +. stylesdir={stylesdir} +. stylesheet={stylesheet} +. pdf-style={pdf-style} + +[IMPORTANT] +==== + +以下のパスを書き換えた：1.2emに。 1.0が今の表示の様子。 +C:\Users\AA004035\.vscode\extensions\joaompinto.asciidoctor-vscode-2.7.6\media\asciidoctor-editor.css +.... + .literalblock pre, + .listingblock>.content>pre:not(.highlight), + .listingblock>.content>pre[class="highlight"], + .listingblock>.content>pre[class^="highlight "] { + font-size: 1.2em; /*　松尾2em;200%でも変更できる*/ + /* background: #f7f7f8 これ消したら消えた*/ + } +.... +==== + +== テストコード + +.... +[IMPORTANT] +==== +本文の記載 +==== + +単行記述は以下： + +IMPORTANT: 本文の記載 +.... + +===== +結局これが一番わかり易いかも +.AsciiDocのチートシート +http://www.venus.dti.ne.jp/~iisaka/DocSys/cheatsheet-ja/asciidoc-869/asciidoc-869.html[AsciiDocのチートシート] +===== + +== テストコードの終わり + += 付録 + +== 属性パラメータ + + * :Keywords:␣ で内部パラメータ定義。キャンセルは``:Keywords!:`` or ``:!Keywords:``。 + * https://asciidoctor.org/docs/user-manual/#builtin-attributes[その他 ビルドインアトリビュートの一覧] + +[cols="1l,1l", options="header"] +|=== +| 記述 | 説明 +|:toc: left | left,right,macro(別途 toc::[]で場所指示） +|:imagesdir: ./ | イメージDIR +|:lang: ja | 言語指定 +|:doctype: book | article/book/manpage/inline(不明) +|:toc-title: 目次 | 目次のタイトル +|:toclevels: 3 | 目次の番号レベル +|:sectnums: | セクションに番号をつけるか? +|:sectnumlevels: 4 | セクションの番号レベル +|:sectlinks: | +|:icons: font | +|:example-caption: 例 | 例ブロック($$====$$)のキャプション +|:table-caption: 表 | テーブルブロック($$====$$)のキャプション +|:experimental: | *マクロを有効するにる +|=== + +.完全な例 +[cols="1l"] +|=== + // 属性定義 +:experimental: + // :module: モジュール名 +:Author: 著者名 +:Email: メールアドレス +:Date: 日付(2020/01/20) +:Revision: Rev.1 +:lang: ja +:doctype: book +:description: +:docname: ドキュメント名 + + // 見出し設定 +:sectnums: +:chapter-label: + // 目次作成 +:toc: left +:toclevels: 3 + // ラベルの日本語設定 +:toc-title: 目次 +:preface-title: はじめに/まえがき +:appendix-caption: 付録 +:caution-caption: 注意 +:example-caption: 例 +:figure-caption: 図 +:important-caption: 重要 +:last-update-label: 最終更新 +:listing-caption: リスト +:manname-title: 名前 +:note-caption: 注記 +:table-caption: 表 +:tip-caption: ヒント +:toc-title: 目次 +:untitled-label: 無題 +:version-label: バージョン +:warning-caption: 警告 + +|=== + +// 定数リファレンスの組み込み diff --git "a/Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.html" "b/Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.html" new file mode 100644 index 0000000..f401a26 --- /dev/null +++ "b/Release/getADoc.Data/adocTPL/HtmlHelp/Adoc\347\260\241\346\230\223\350\252\254\346\230\216help.html" @@ -0,0 +1,3295 @@ + + + + + + + +Asciidoc help(表現を試す) + + + + + +
+
+
+
+

+
+
+

+
+ + +
+

+
+
+
+
+

1. はじめに

+
+
+

AsciiDocの記述方法でよくつかうものを記載します。さらに多くの記述を使いたい場合は以下を参照してください。

+
+
+ +
+
+ +
+
+
+
+
その他
+
+
+ +
+
+
+
+
+
+
+

2. コメント類

+
+
+

コメント部分は、最終出力から除外されます

+
+
+
+
 // 			:行頭でその行はコメントになる
+ ////から////	:ブロック内がすべてコメント
+
+
+
+
+
+

3. 文字飾り

+
+
+
基本
+

`*_`でサンドイッチすることで表現。空白含む場合は **単語A 単語B** の様に２個ずつつけるとよい

+
+ ++++ + + + + + + + + + + + + +
結果記述
+

太字の語句
+イタリック
+太字のイタリック
+モノスペース

+
*太字の語句*
+_イタリック_
+*_太字のイタリック_*
+`モノスペース`
+ + ++++ + + + + + + + + + + + + +
少し拡張(アンダーラインなど)
結果記述
+

アンダーライン
+通常文字 vs 小さい文字 vs 大きい文字

+
+
+

取り消し線

+
[.underline]#アンダーライン#
+通常文字 vs [.small]#小さい文字# vs [.big]#大きい文字#
+
+[.line-through]#取り消し線#
+
+
+
+

4. 見た目(ボタンとアイコン)

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
記述説明
kbd:[Ctrl+C]
+

Ctrl+C, Ctrl+Shift+V

+
btn:[ボタン]
+

ボタン,OK,CANCELなど

+
{cboxOn}/{cboxOff}
+

[✔]/[ ] 以下の事前マクロ定義必要
+ :cboxOn: pass:normal[``{startsb}&#10004;{endsb}``]
+ :cboxOff: pass:normal[``{startsb}{nbsp}{endsb}``]

+
{cboxgOn}/{cboxgOff}
+

✔/  以下の事前マクロ定義必要
+ :cboxgOn: kbd:[&#10004;]
+ :cboxgOff: kbd:[{nbsp}]

+
menu:ファイル[保存]
+

ファイル › 保存

+
+
+
+
階層化:>でサブメニュー化
+
+

menu:ファイル[保存 > Sub > A]
+→
+ファイル › 保存 › Sub › A

+
+
+
+

{OK}

+
+

事前に定義
+:OK: pass:[<span style="font-family: monospace">&#x1F600;</span>&#x20;]
+😀
+アイコンはユニコードで色々定義,Unicodeの絵文字
+😍(&#x1F60D;)、🙅(&#x1F645;)、🌈(&#x1F308;) などなど

+
+
+
+
+

5. セクション（章節）

+
+
+

=␣<セクション>で始める行がセクションになる。セクションの区切りには空白行が必要。=の数でセクションレベルが決まる

+
+
+
+
= ドキュメントのタイトル
+== 章最初のタイトル
+=== 節のタイトル
+==== 文節のタイトル
+===== さらにその下タイトル
+====== さらにさらにタイトル
+== 章次のタイトル
+
+
+
+
+
+

6. 箇条書き

+
+
+
    +
  • +

    *␣<項目>、-␣<項目>で始める。異なる記号を使えば、階層的に表現できる

    +
    • +
  • +

    形状変更は[square],[circle],[disc]を指定

    +
    • +
  • +

    チェックボックスは*␣[ ]␣ <項目>。 []の中に[x] or [*] or [ ]

    +
    • +
  • +

    箇条書きブロックを区切るには 空行 + //- + 空行をいれる。もしくは空行 + []。

    +
    • +
+
+ + ++++ + + + + + + + + + + + + + + + + + + + + +
箇条書き(項目)
結果記述
+
    +
  • +

    項目1

    +
    +
      +
    • +

      サブ項目1

      +
      • +
    • +

      サブ項目2

      +
      +
      +
      +

      サブ項目の中に複数行に渡る大きな大きなブロックを記述できる

      +
      +
      +
      +
      • +
    +
    +
    • +
  • +

    項目2

    +
    • +
+
- 項目1
+	* サブ項目1
+	* サブ項目2
++
+--
+サブ項目の中に複数行に渡る大きな大きな大きな
+ブロックを記述できる
+--
+- 項目2
+
形状変更
+
    +
  • +

    square

    +
    • +
+
+
+
    +
  • +

    circle

    +
    • +
+
+
+
    +
  • +

    disc

    +
    • +
+
+
+
    +
  • +

    none bullet

    +
    • +
+
.形状変更
+[square]
+* square
+
+[circle]
+* circle
+
+[disc]
+* disc
+
+[none]
+* none bullet
+
チェックボックス
+
    +
  • +

    ✓ checked

    +
    • +
  • +

    ✓ also checked

    +
    • +
  • +

    ❏ not checked

    +
    • +
  • +

    no symbol marks

    +
    • +
+
.チェックボックス
+* [*] checked
+* [x] also checked
+* [ ] not checked
+* no symbol marks
+
+
+
+

7. 箇条書き（数字）

+
+
+

.␣<項目>（ピリオド）で始める。階層構造は…​␣と連ねる。
+番号は[arabic]/[decimal]/[loweralpha]/[upperroman]などで階層ごとに指定

+
+ + ++++ + + + + + + + + + + + + +
箇条書き(数字)
結果記述
+
    +
  1. +

    項目1

    +
    +
    項目1のタイトル
    +
    +
    +

    サブ項目の中にブロックを記述できる

    +
    +
    +
    +
    +
      +
    1. +

      サブ項目1

      +
      2. +
    2. +

      サブ項目2

      +
      +
        +
      1. +

        サブサブ1

        +
        2. +
      2. +

        サブサブ2

        +
        +
        +
        +

        サブ項目の中にブロックを記述できる

        +
        +
        +
        +
        3. +
      +
      +
      3. +
    +
    +
    2. +
  2. +

    項目2

    +
    3. +
+
+
+
. 項目1
++
+--
+サブ項目の中にブロックを記述できる
+--
+	.. サブ項目1
+	.. サブ項目2
+[decimal]
+	... サブサブ1
+	... サブサブ2
+
++
+--
+サブ項目の中にブロックを記述できる
+--
+
+
+
+
+
+

8. ラベル

+
+
+
    +
  • +

    <ラベル名>::(後ろのコロン２つ）でラベルをつける。コロンを増やせば階層化できる。

    +
    • +
  • +

    [horizontal]指定で一行目から、行が開始される

    +
    • +
+
+ + ++++ + + + + + + + + + + + + +
ラベル
結果記述
+
+
第一項
+
+

第一項の定義

+
+
+
さらにそのサブ
+
+

サブの内容

+
+
+
+
+
+
+
+
第一項::
+	第一項の定義
+	さらにそのサブ:::
+		サブの内容
+
+
+
+
+
+

9. ブロックラベル

+
+
+

.ブロックラベル(ドット）でラベルをつける。スペースは不要。箇条書き（数字）になってしまう。

+
+
+
+
+

10. ブロック

+
+
+
    +
  • +

    以下の記号４文字のキーワード行で囲む。それぞれ動作、意味が異なる

    +
    • +
  • +

    {ddollar}～ {ddollar}で囲むとパスされる →　エスケープ方法

    +
    • +
+
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

1

--

(ハイフンx2)

オープンブロック。 汎用ブロック。オープンブロックはpassとtableを除き、他のブロックとして機能できます。

2

----

(ハイフンx4)

コードブロック。コードもしくはファイルの表示(リスティング)

3

....

(ドット)

リテラルブロック。書いたままに表示させたいとき。

4

====

(イコール)

サンプルブロック。 通常で枠ができるフォーマット。[caption="キャプション名"]で制御。= のみで、ナンバリングもキャプションも除去される様子

5

++++

(プラス)

インラインブロック。変換せずにHTML出力,パススルー/インライン,バックエンドのマークアップの書式を記述する

6

****

(アスタ)

サイドバーブロック

7

____

(アンダーバー)

ブロッククウォート（引用かな?）

+
+
+
コードブロックに指定できる言語
+
+
+
+
+

C,C++,HTML,Python,Ruby,JavaScript,JSON,Java,XML,YAML
+,Clojure,CSS,Delphi,diff,ERB,Go,Groovy,HAML,Lua
+,PHP,Sass,SQL,Taskpaper

+
+
+
+
+
コードブロックで改行禁止New
+
+
+
+
 .CodeBlock
+ [%nowrap]
+ ----
+   ....
+ ----
+
+
+
+
+
+ ++++ + + + + + + + + + + + + +
結果記述
+
JavaScript例（タイトル）
+
+
var a = "test";
+echo(a,b);
+
+
+
+
 [source,JavaScript]
+ .JavaScript例（タイトル）
+ ----
+ var a = "test";
+ echo(a,b);
+ ----
+
+
+
+
+
コードブロックの属性変更
+
+

リテラルなブロックでもマクロなどが利用可能にできます。

+
+
+
+
+
+
 ----
+    ##hoge##
+ ----
+
+
+
+

→

+
+
+
+
 [subs="normal,-post_replacements"]
+ ----
+	hoge
+ ----
+
+ これでもよい：[subs="verbatim,specialchars,callouts,attributes,replacements,macros,quotes"]
+
+
+
+
+
+

11. 警告、重要、情報などのアイコン

+
+
+

適用するには属性 :icons: fontが必要

+
+ ++++ + + + + + + + + + + + + +
結果記述
+ + + + + +
+
注記
+		 +ノート(NOTE) +
+
+
+ + + + + +
+
警告
+		 +警告(WARNING) +
+
+
+ + + + + +
+
重要
+		 +重要(IMPORTANT) +
+
+
+ + + + + +
+
ヒント
+		 +チップス(TIP) +
+
+
+ + + + + +
+
注意
+		 +注意(CAUTION) +
+
+
+
NOTE,WARNING,IMPORTANT,TIP,CAUTION
+
+単行の場合:
+
+NOTE: <内容>
+
+ブロックの場合: (サンプルブロックを使う)
+
+[NOTE]
+====
+<内容>
+====
+
+
+
+
■カスタムアイコンの利用方法
+

PNGもしくはSVGデータとしてこれらのアイコンを変更することができます。iconsフォルダにファイル名"NOTE,WARNING,IMPORTANT,TIP,CAUTION"で、拡張子を.svgもしくは.pngのファイルを配置すればよい。

+
+ + ++++ + + + + + + + + + + + + + + +
アイコンの属性を変更 
:icons: image
+

アイコンのタイプをイメージに変更

+
:iconsdir: ./icons
+

アイコンの配置場所をiconsに変更（未設定だと{imagesdir}/icons)

+
:icontype: svg
+

画像の種類を指定 svg or png

+
+
+ + + + + +
+
重要
+		 +属性変更はファイルの先頭がよい。途中で切り換えるとうまくいかない場合があった。 +
+
+
+
+
※その他方法
+
+

以下でも一時的に変更することも可能。拡張子は:icontype: xxxと同じなら 拡張子を省略可能です

+
+
+
+

[NOTE, icon=NoteCustom.svg ]
+====
+カスタムNOTEアイコン
+====

+
+
+
+
+
+
+
+
+
+

12. 区切り線

+
+
+

---（ハイフン）3個のみ。

+
+ + ++++ + + + + + + + + + + + + +
区切り線
結果記述
+

---

+
+
+
+
+

13. 改行

+
+
+
    +
  • +

    ␣+で繋ぐ。

    +
    • +
  • +

    もしくは[%hardbreaks]で段落全体で改行を有効にする（段落毎にリセットされる）。
    +ドキュメント全体で設定するなら:hardbreaks:属性をつけるとよい。個別の解除は{set:hardbreaks\!}。

    +
    • +
  • +

    New! [.nw]##... hoge hoge ...##で自動改行を抑制かつ複数空白記述可能。別名:.nowarp
    +表のセル幅が狭く、改行される場合に、ヘッダ行に指定することでヘッダ行の幅でセル幅を抑制できる。(結構有効)。

    +
    • +
+
+
+ + + + + +
+
重要
+		 +
+

config.adocのインクルード後、属性設定の後、表題の直前にを記述すること。
+toc: leftの前に定義すると目次が表示されなくなります。

+
+
+
+
+
    +
  • +

    Obsolete! {NoWrap}…​ hoge hoge …​{End}で自動改行を抑制 前記のものがあるのでもう使わないこと
    +表のセル幅が狭く改行される場合に、ヘッダ行に指定することでヘッダ行の幅でセル幅を抑制できる。

    +
    +
    +
    	// Macro
+	:NoWrap: pass:[<span style="display:inline-block;white-space:pre;">]
+	:Wrap: pass:[<span style="display:inline;white-space:pre;">]
+	:End: pass:[</span>]
    +
    +
    +
    • +
+
+ + ++++ + + + + + + + + + + + + +
改行
結果記述
+

１行目
+２行目

+
１行目 +
+２行目
+
+
+
+

14. 段落 揃え

+
+
+
    +
  • +

    [.text-left],[.text-right],[.text-center]で調整する

    +
    • +
  • +

    [.text-justify]はよくわからない

    +
    • +
  • +

    [align=xxxx]、 xxxx=left,center,right,…​でもよい

    +
    • +
+
+ ++++ + + + + + + + + + + + + +
結果記述
+

右寄せ

+
+
+

センター

+
+
+

左

+
+
+

行内で部分的右 [右]

+
[.text-right]
+右寄せ
+[.text-center]
+センター
+[.text-left]
+左
+行内で部分的右 [.right]##[右]##
+
+

This paragraph is aligned right

+
+
+

This paragraph is aligned center

+
+
+

This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left. This paragraph is aligned left.

+
+
+

This paragraph is justified, which is the default.This paragraph is justified, which is the default.This paragraph is justified, which is the default.This paragraph is justified, which is the default.

+
+
+
+
+

15. コメント

+
+
+
+
// コメント行
+
+////
+	コメントブロック
+////
+
+
+
+
+
+

16. エスケープ方法

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
記述表現
+

{ddollar} ～ {ddollar}で囲む

+
+

通常文字になる

+
+

+++～+++で囲む

+
+

HTML制御になる(インライン要素)

+
+

pass:[～]で囲む

+
+

HTML制御になる(インライン要素、同上）

+
+

\(backslash)

+
+

次の文字の制御のみキャンセル。\*bold*や\{lt}など

+
+

※ その他は特殊記号で記載すること。

+
+
+
+
+

17. 特殊記号

+
+
+

特殊記号は{}を使う。もしくは&#<10進数>; or &#x<10進数>;など。

+
+ + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
特殊記号の一覧
記号    * ({}で囲む)表現
+

dollar

+
+

$(ドル): &#36; or &#x24;
+※これは存在しないので、自身で:dollar: &#36;を定義すること

+
+

sp

+
+

スペース１文字

+
+

nbsp

+
+

ノンブランクスペース文字

+
+

zwsp

+
+

幅無スペース

+
+

quot

+
+

" (ダブルクウォート)

+
+

apos

+
+

' (アポストロフィー}

+
+

backtick

+
+

` (バッククウォート)

+
+

lsquo

+
+

‘(開始シングルクウォート)

+
+

rsquo

+
+

’(終了シングルクウォート)

+
+

ldquo

+
+

“(開始ダブルクウォート)

+
+

rdquo

+
+

”(終了ダブルクウォート)

+
+

deg

+
+

°(角度)

+
+

plus

+
+

+(プラス)

+
+

brvbar

+
+

¦

+
+

vbar

+
+

|(論理和)

+
+

amp

+
+

& (アンパサンド)

+
+

lt

+
+

< (smaller than)

+
+

gt

+
+

> (gretar than)

+
+

startsb

+
+

[ (開始カギカッコ）

+
+

endsb

+
+

] (終了カギカッコ)

+
+

caret

+
+

^ (キャレット)

+
+

asterisk

+
+

* (アスタリスク)

+
+

tilde

+
+

~ (チルダ)

+
+

backslash

+
+

\ (バックスラッシュ)

+
+

two-colons

+
+

:: (2つのコロン)

+
+

two-semicolons

+
+

;; (2つのセミコロン)

+
+

cpp

+
+

``C`` (C?)

+
+

wj

+
+

blank

+
+

empty

+
+
+
+
+

18. 色

+
+
+

[色 色-background]#コンテンツ#で指定する

+
+
+
+
+

赤いコンテンツ、黄色の背景 ← [red yellow-background]## 赤いコンテンツ、黄色の背景 ##

+
+
+
+
+
    +
  • +

    色名の一覧はwikiのWebColor一覧から取れる

    +
    +
    +
    +

    HTML color names
    +この内の基本の16種の色のみ定義されている

    +
    +
    +
    +
    +
    +
    asciidoctor-pdfは以下の定義みたい(rubyの中)
    +
    +

    c:\Ruby24\lib\ruby\gems\2.4.0\gems\asciidoctor-2.0.10\data\stylesheets
    +asciidoctor-default.css

    +
    +
    vs-codeプラグインは以下
    +
    +

    %USERPROFILE%\.vscode\extensions\asciidoctor.asciidoctor-vscode-2.8.3\media\
    +asciidoctor-default.css

    +
    +
    一覧
    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    ■■■■■■■ aqua
    + ([aqua]##■...■## aqua )

    +
    +

    ■■■■■■■ black

    +
    +

    ■■■■■■■ white

    +
    +

    ■■■■■■■ fuchsia

    +
    +

    ■■■■■■■ green

    +
    +

    ■■■■■■■ lime

    +
    +

    ■■■■■■■ maroon

    +
    +

    ■■■■■■■ navy

    +
    +

    ■■■■■■■ olive

    +
    +

    ■■■■■■■ purple

    +
    +

    ■■■■■■■ red

    +
    +

    ■■■■■■■ silver

    +
    +

    ■■■■■■■ teal

    +
    +

    ■■■■■■■ yellow

    +
    +

    ■■■■■■■ yellow

    +
    +
    +
    +
    +
    • +
+
+
+

※色を拡張したければインラインで定義するか、CSSを拡張するかです。

+
+
+
インラインで拡張
+
+
+
+
+
+
:SpanRed: pass:[<span style="color:#FF00FF;background-color:#00FFFF">]
+// Spanの終了は共通{SpanEnd}
+:SpanEnd: pass:[</span>]
+
+
+
+

このように定義しておいて
+{SpanRed} 適当な文字列 {SpanEnd} → 適当な文字列

+
+
+
+
+
+
+
CSSで拡張
+
+
+

未記載

+
+
+
+
+

The application is called MyApp2.

+
+
+

example-caption=
+figure-caption=図

+
+
+

Red `sum_(i=1)\^n i=(n(n+1))/2`$ ←AsciiMathML formula

+
+
+

pass_attribute=the ''
+※ passすると[%hardbreaks]などリセットされちゃう

+
+
+

lang=ja
+menu=File › Save
+keyboad=F11
+docdate=2024-11-20
+user-home=C:\Users\AA004035

+
+
+
+
+

19. 独自のマクロみたいなの

+
+
+
    +
  1. +

    HTML文法における id / class 指定の対応

    +
    2. +
+
+
+
+
<div id="baz" class="foo bar">
+
+
+
+

idは要素そのもののユニークなID、classはCSSの指定でスタイルを指定可能。
+これは以下の２通りで表現可能
+[#<ID>.<CLASSList1>.<CLASSList1>] ⇐ これでよいと思う
+もしくは
+[[<ID>]]
+[role="<CLASSList1> <CLASSList1>]

+
+
+
+
	[#baz.foo.bar]
+	----
+	block
+	----
+もしくは
+	[[baz]]
+	[role="foo bar"]
+	----
+	block
+	----
+
+
+
+

xabc

+
+
+

{ZZ}
+abc

+
+
+

独自のasciidocマクロを定義する方法

+
+
+
+
{set:cellbgcolor:gray}
+[grid=none, frame=none]
+|===
+| X >| Y
+|===
+{set:cellbgcolor!}
+
+
+
+

+
+ ++++ + + + + + + +

X

Y

+
+

+
+
+

{

+
+ +++ + + + + + + + + +

a #FF0000

Cell data

+
+
+
+

20. リンク

+
+
+

WebページなののURLへのリンク。<url>[リンク表示]
+Windowsファイルパスの場合は、link:<path>[リンク表示]
+リンク表示名の最後に^（キャレット）を追加すると別ウインドウで開く。^は[windows=_blank]の省略表現。
+santanaのCMM

+
+ + ++++ + + + + + + + + + + + + +
タイトル例
結果記述
+

チートシート英語
+別ウインドウで開く↓
+チートシート英語別Window
+別ウインドウで開く(タイトル無し）↓
+https://asciidoctor.org/docs/user-manual/

+
+
+
https://asciidoctor.org/docs/user-manual/[チートシート英語]
+別ウインドウで開く↓
+https://asciidoctor.org/docs/user-manual/[チートシート英語別Window^]
+別ウインドウで開く(タイトル無し）↓
+https://asciidoctor.org/docs/user-manual/[^]
+
+
+
+
+
+

21. イメージリンク

+
+
+
    +
  • +

    通常

    +
    +
    +
    image::im.JPG[代替テキスト,x,y,.... align="right/left/center"]
+
+x,yは表示ピクセル数を指定するか
+もしくは%を用いて実際の表示幅からの割合表示が可能
+image::im.JPG[代替テキスト,"50%"]
+また明示的に記載も可能(width,height)
+image::im.JPG[代替テキスト,width="50%"]
    +
    +
    +
    • +
  • +

    インライン（行内)

    +
    +
    +
    		image:im.JPG[代替テキスト]
    +
    +
    +
    • +
+
+
+
+代替テキスト +
+
+
+

行で　代替テキスト　をいれる

+
+
+
+
+

22. テーブル

+
+
+

22.1. テーブルの表現

+ + ++++ + + + + + + + + + + + + + + + + +
タイトル例
結果記述
+
+ ++++ + + + + + + + + + + + + +
c1c2
+

data1

+
+

data2

+
+
+
+
+
[cols="1a,2a",options="header"]
+|===
+|c1        |c2
+|data1     |data2
+|===
+
+
+

その他の細かい記述方法

+
+

*まだ* +

+
+
+
+
+
+
cols=
+
+
+
    +
  • +

    番号で列の幅比率

    +
    • +
  • +

    a:adoc書式、l(エル):リテラル書式

    +
    • +
+
+
+
+
+
+
+
+ + + + + +
+
注記
+		 +テーブル内でテーブルを使う場合(Nested Table)は、|の代わりに!(ビックリマーク)を使う。それでも完全で無い。 +
+
+
+
+
寄せの設定
+
+
+
+
[cols="<,>,^"]
+
+
+
+
+ +++++ + + + + + + + +

1列目: 左寄せ

2列目: 右寄せ

3列目: 中央寄せ

+
+
+
+
寄せの設定2
+
+
+
+
[cols="{左右}.{上下}, {左右}.{上下}, {左右}.{上下}, ..."]
+[cols="{左右}.{上下}, {左右}.{上下}, {左右}.{上下}, ..."]
+
+
+
+
+ ++++ + + + + + + +

[cols="<.<,"]は 1列目: 左寄せ + 上寄せ

2列目1
+2列目2

+ ++++ + + + + + + +

[cols=">.>,"]は 1列目: 右寄せ + 下寄せ

2列目1
+2列目2

+ ++++ + + + + + + +

[cols="^.^,"]は 1列目: 中央(左右) + 中央寄せ(上下）

2列目1
+2列目2

+
+
+
+
寄せの設定3
+
+
+
+
+
行定義|の左側に<,>,^を記述する方法もある。1列ごとに改行して定義する。
+※ヘッダ行とデータ行の間に改行が必要
+|item
+<|item
+>|item
+<.^|item
+
+
+
+
+
列幅の設定
+
+
+
+
以下の自動幅autowidth:OK,様々指定方法がある。どれか一つ。
+[options="header,autowidth"]
+[options="autowidth"]
+[%autowidth]
+[%header%autowidth]
+["%autowidth",cols="a,a",options="header"]
+※ a,100aはadoc2pdf変換で失敗 1:40で失敗,最大39でいけた
+
+
+
+
+
+
+
+

22.2. テーブルを段組

+
+ + + + + +
+
注意
+		 +「イメージを左、その説明を右」ぐらいの用途。テーブルにテーブルをいれるのが難しいなど、全表現をいれるのに苦労するのでやめたほうがいい。 +
+
+ + ++++ + + + + + + +
テーブルを段組みに使う（2分割）
+
+代替テキスト +
+
画像タイトル名
+
+ + ++++ + + + + + + + + + + + + +
テーブルにテーブルを入れている
head ahead b
+

a

+
+

BBBBBB

+
+
+
+
これが二つ目のブロックになる
+
    +
  1. +

    ラベル

    +
    2. +
  2. +

    ラベル

    +
    3. +
+
+
+
+
+
表現は以下のとおり
+
+
	[title="ｘｘｘ",caption="",cols="a,a",frame="none",grid="all"]
+	|================================
+	|
+	// 左段落
+	[caption="",title="画像タイトル名",grid="all"]
+	image::im.JPG[代替テキスト,100,align="center"]
+
+	[caption=""]
+	.テーブルにテーブルを入れている
+	[cols="1a,2a", options="header"]
+	// [frame="none",grid="none"]
+	!=========
+	!head a	! head b
+	!a		! BBBBBB
+	!=========
+
+	|
+	// 右段落
+	--
+	.これが二つ目のブロックになる
+	. ラベル
+	. ラベル
+	--
+	|================================
+
+
+
+
+

22.3. テーブル 飾り

+
+

[cols=…​,opts=…​,frame=none,grid=none,stripes=none]

+
+ ++++ + + + + + + + + + + + + + + +
+

frame:

+
+

表の枠. none: 無し, all: 全枠, ends: 上下のみ, sides:左右のみ

+
+

grid:

+
+

セルの枠. none:無し, all:全セル枠, rows:行のみ, cols:列のみ

+
+

stripes:

+
+

ストライプの背景. none:無し, even:偶数行のみ, odd:奇数行のみ, all: すべて,hover: マウス通過時（HTMLのみ)

+
+
+
+
+
+

23. テキストの折り畳み

+
+
+

[%collapsible]で記述する

+
+
+
+
.タイトル
+[%collapsible]
+====
+～ ※[%collapsible%open]と指定すると初期状態で展開される
+====
+
+
+
+折り畳みテキスト +
+
+

折り畳み内容

+
+
+
+
+
+
+

24. インクルード

+
+
+

include::../../hoge.adoc[]で別のAsciiDocファイル指定する。
+[]内にオプションを指定できる

+
+
+
+
include::path[leveloffset=offset,lines=ranges,tag(s)=name(s),indent=depth,opts=optional]
+
+
+
+
+
leveloffset= +n
+
+

セクション階層を変更する。＋の数値を指定することで、階層を下げる。マージしたadocのセクション階層と、include先のadocも単独で参照するようなケースに有効です

+
+
+
+
+
+
+

25. ページサイズ

+
+
+

HTML変換すると、A4サイズに出力されてしまう。ページ幅をウインドウサイズで任意に広がるようにするためには、指定されているCSS(スタイルシート）のmax-width:62.5em;で固定されています。ページ幅を任意にするためにmax-width:none;で 上書きすればよい。

+
+
+
config.docを利用している場合
+
+
+

{ExtendStyle}の次で{FreePage}を有効にすればよい。

+
+
+
+
{ExtendStyle}
+//{FreePage}		-> コメントアウトを外す
+// After need empty-one-line
+
+
+
+
+
+
自分で記述する場合
+
+
+

Adocファイルの上の方で、以下の記述を追加すればよい：

+
+
+
+
++++
+<style> #header,#content,#footnotes,#footer{max-width:none;} </style>
+++++
+
+
+
+
+
+
参考：変換時に指定されるCSSの記述例
+
+
 ...
+#header,#content,#footnotes,#footer{width:100%;margin-
+left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:。
+9375em}
+ ....
+
+
+
+
+
+

26. アンカー(内部参照)

+
+
+
    +
  • +

    内部参照へのリンクを表現する。 [[アンカー名 ]]で設定し、<<アンカー名 >>で参照する。設定された直後の章名がアンカー表示名になる。

    +
    • +
  • +

    アンカー参照時の表示名を別名にしたいときは、設定箇所で[[アンカー名,表示名]]とする。

    +
    • +
  • +

    デフォルトで、章は、アンカーが設定されており,<<_章名>>(先頭にアンダーバー)で参照できる。vscodeプレビューは日本語でリンクに飛べなかった？

    +
    • +
+
+
+

例.

+
+
+
+
+

イメージリンク

+
+
+
+
+
+
+

27. 属性設定のサンプル

+
+ +
+
+

その他

+
+
+
+
    +
  1. +

    (済)アンカー(内部参照)

    +
    2. +
  2. +

    色名

    +
    3. +
  3. +

    本

    +
    4. +
+
+
+
+
+

28. オリジナル先のリンクをしっかりしておこう

+
+
+

トップページ_Asciidoctor Documentation

+
+
+

Syntax-quick-ref

+
+
+

writers-guide

+
+
+

diagram

+
+
+

style-guide(draft)

+
+
+

macro defineがあるんですけどね

+
+
+
+

Nested Tables

+
+
+
+

Nested tables

+
+
+
+
+

29. Nested tables

+
+
+

To nest a table in a table we must
+use ! as table separator instead of |.
+Also the type of the column or cell
+must be set to a so Asciidoc markup
+is processed.

+
+ ++++ + + + + + + + + + + + + + + + + +
Col 1Col 2

Cell 1.1

+

Cell 1.2

+

Cell 2.1

+

Cell 2.2

+
+ ++++ + + + + + + + + + + + + +
Col1Col2

C11

C12

+
+

MyAp2

+
+
+

MyApp2

+
+
+ + + + + + + + + + + + + +
+CPUここが長くなってしまうとどうする + +

The brain of the computer.

+
+
    +
  • +

    a

    +
    • +
  • +

    b

    +
    • +
+
+
+Hard drive + +

Permanent storage for operating system and/or user files.

+
+RAM + +

Temporarily stores information the CPU uses during operation.

+
+
+
+
+
+

+
+.Q and A

+
+
+
    +
  1. +

    アスキードックとは？

    +

    ルビーで実装されたドキュメントフォーマットである。

    +
    2. +
  2. +

    What is the answer to the Ultimate Question?

    +

    42
    ++

    +
    3. +
+
+
+
+
+ + + + + +
+ + +It’s possible to use Unicode glyphs as admonition icons.
+WARNING: It’s possible to use Unicode glyphs as admonition icons. +
+
+
+ + + + + +
+ + +It’s possible to use Unicode glyphs as admonition icons.
+WARNING: It’s possible to use Unicode glyphs as admonition icons. +
+
+
+

ruby, asciidocto

+
+
+
+\$sqrt(4) = 2\$ +
+
+
+
+\$sqrt(4)\$ +
+
+
+

latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon

+
+
+
+
An open block can be an anonymous container, or it can masquerade as any other block. pass:[dfsa]
+
+
+
+

An open block can be an anonymous container, or it can masquerade as any other block. dfsa

+
+
+

.

+
+
+
+

まとめ

+
+

30. タイトル

+
+
+

。。。（。。。）

+
+ + ++++ + + + + + + + + + + + + +
タイトル例
結果記述
+

<左列のレンダリング結果>

+
+
+
<右側列のAsciiDocの記述>
+
+
+
+
+

属性関係の設定

+
+
+
+

脱Word、脱Markdown、asciidocでドキュメント作成する際のアレコレ

+
+
+

HTMLのスタイル(CSS)を設定する

+
+
+
+
// :stylesdir:   // どこでも有効になる様子
+//:stylesdir:でCSSのフォルダを:stylesheet:でCSSファイルを指定可能
+
+// html-style.adoc
+// :stylesdir: stylesheets/
+// :stylesheet: asciidoctor-default.css
+
+// pdf-style.adoc
+// :pdf-style: themes/default-theme.yml
+
+
+
+
    +
  1. +

    stylesdir=.

    +
    2. +
  2. +

    stylesheet=

    +
    3. +
  3. +

    pdf-style={pdf-style}

    +
    4. +
+
+
+ + + + + +
+ + +
+

以下のパスを書き換えた：1.2emに。 1.0が今の表示の様子。
+C:\Users\AA004035\.vscode\extensions\joaompinto.asciidoctor-vscode-2.7.6\media\asciidoctor-editor.css

+
+
+
+
	.literalblock pre,
+	.listingblock>.content>pre:not(.highlight),
+	.listingblock>.content>pre[class="highlight"],
+	.listingblock>.content>pre[class^="highlight "] {
+		font-size: 1.2em;	/*　松尾2em;200%でも変更できる*/
+		/* background: #f7f7f8 これ消したら消えた*/
+	}
+
+
+
+
+
+
+
+

31. テストコード

+
+
+
+
[IMPORTANT]
+====
+本文の記載
+====
+
+単行記述は以下：
+
+IMPORTANT: 本文の記載
+
+
+
+
+
+

結局これが一番わかり易いかも
+.AsciiDocのチートシート
+AsciiDocのチートシート

+
+
+
+
+
+
+

32. テストコードの終わり

+
+ +
+
+

付録

+
+

33. 属性パラメータ

+
+
+ +
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
記述説明
:toc: left
 left,right,macro(別途 toc::[]で場所指示）
:imagesdir: ./
 イメージDIR
:lang: ja
 言語指定
:doctype: book
	article/book/manpage/inline(不明)
:toc-title: 目次
	目次のタイトル
:toclevels: 3
	目次の番号レベル
:sectnums:
	セクションに番号をつけるか?
:sectnumlevels: 4
	セクションの番号レベル
:sectlinks:
:icons: font
:example-caption: 例
	例ブロック($$====$$)のキャプション
:table-caption: 表
 テーブルブロック($$====$$)のキャプション
:experimental:
	*マクロを有効するにる

+
+
+++
+
+
+
+
+
+
完全な例


 // 属性定義
+:experimental:
+ // :module:    モジュール名
+:Author:    著者名
+:Email:     メールアドレス
+:Date:      日付(2020/01/20)
+:Revision:  Rev.1
+:lang: ja
+:doctype: book
+:description:
+:docname: ドキュメント名
+
+ // 見出し設定
+:sectnums:
+:chapter-label:
+ // 目次作成
+:toc: left
+:toclevels: 3
+ // ラベルの日本語設定
+:toc-title: 目次
+:preface-title: はじめに/まえがき
+:appendix-caption: 付録
+:caution-caption: 注意
+:example-caption: 例
+:figure-caption: 図
+:important-caption: 重要
+:last-update-label: 最終更新
+:listing-caption: リスト
+:manname-title: 名前
+:note-caption: 注記
+:table-caption: 表
+:tip-caption: ヒント
+:toc-title: 目次
+:untitled-label: 無題
+:version-label: バージョン
+:warning-caption: 警告

+

+

+

+
+
+
\ No newline at end of file
diff --git a/Release/getADoc.Data/adocTPL/HtmlHelp/config.adoc b/Release/getADoc.Data/adocTPL/HtmlHelp/config.adoc
new file mode 100644
index 0000000..2961955
--- /dev/null
+++ b/Release/getADoc.Data/adocTPL/HtmlHelp/config.adoc
@@ -0,0 +1,344 @@
+ifndef::_CONFIG_ADOC[]
+// INCLUDE GUARD
+:_CONFIG_ADOC: IncludeGuard
+//
+//-----------------------------------------------------------------------------------------------------
+//
+// 事前定義
+ifndef::UserConfigEnd[]
+:toc: left
+:sectnums:
+endif::UserConfigEnd[]
+//[イメージのパスを指定]
+:imagesdir: Images
+ifeval::["{lang}" == "ja"]
+:toc-title: 目次
+:example-caption: 
+:caption:  
+//: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::[]
+// ここまで空白行禁止(tocが表示されない)
+
+// HTML出力で画像を埋め込む
+:data-uri: 
+// 各種Macro拡張
+:hardbreaks:
+:experimental: 
+// ExtendStyleは常に有効とする。定義して、もう実行しておく。互換性：何回呼ばれても大丈夫。
+:ExtendStyle: pass:none[]
+{ExtendStyle}
+
+// Page幅を無効にする
+
+ifdef::FreePage[]
+++++++
+endif::FreePage[]
+// 互換性:{FreePage}がConfigより後で定義された場合は、互換性ため{FreePage}を定義する
+ifndef::FreePage[]
+:FreePage: pass:none[]
+endif::FreePage[]
+
+// SCREEN Confidential
+
+:HeadLine: 
+
+ifdef::SCREENConfidential[]
+:SCREENGA: pass:q[image:SCREENGA.png[]]
+:CONF: 		pass:q[image:Confidential.png[]]
+:DocNo: Internal
+:HeadLine: 	pass:n[{SCREENGA} [.right]##{DocNo}  {CONF}##]
+endif::SCREENConfidential[]
+
+// ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ css差分
+++++
+
+++++
+// ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
+
+// :TocMode: WordWrap or ExpandWidth or Other None WordWrapが初期値
+ifndef::TocMode[]
+:TocMode: WordWrap
+endif::TocMode[]
+
+ifeval::["{TocMode}" == "WordWrap"]
+// ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ css差分
+++++
+
+++++
+// ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
+endif::[]
+ifeval::["{TocMode}" == "ExpandWidth"]
+// ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ css差分
+++++
+
+++++
+// ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
+endif::[]
+
+ifeval::["{CustomIcon}" == "ja"]
+:icons: image
+:iconsdir: icons
+:icontype: png
+endif::[]
+
+ifdef::CustomIcon_nouse[]
+// ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ css差分
+++++
+
+++++
+// ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
+endif::CustomIcon_nouse[]
+
+// End of ::_CONFIG_ADOC[]
+endif::_CONFIG_ADOC[]
+
diff --git a/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.adoc b/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.adoc
index d80c26d..d37c47c 100644
--- a/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.adoc
+++ b/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.adoc
@@ -1,25 +1,23 @@
 
+= ReadMe.AsciiDocTool
+// If disable,set "!" : ":key: " -> ":!key: ".
 :lang: ja
-:docname: ReadMeAsciiDocTool
-
-:conf: {docname}.adoc
-include::{conf}[tag="CONFIG"}]
-//:toc: left
-
-// Custom Icons(J)
-//:icons: image
-//:iconsdir: icons
-//:icontype: png
-//
-
-{ExtendStyle}
-// After need empty-one-line
-
+:doctype: book
+:toc: left
+:toclevels: 3
+:sectnums:
+:sectnumlevels: 4
+:sectlinks:
+:FreePage: 
+:!CustomIcon: ja
+:UserConfigEnd:
+include::config.adoc[]
 
+{HeadLine}
 
-= ReadMe.AsciiDocTool
 [.text-right]
 --
+2024/11/27 松尾：helpとdrawio追記
 2021/09/13 AP開発 松尾
 --
 
@@ -56,16 +54,34 @@ image:tree.png[t,200]
 == ヘルプ
 
 コマンドラインからgetAdoc.bat /?で以下のヘルプを表示
-----
-getADoc /S|SepaDoc /O|OneDoc /I|Icons /SCREEN /Force *
+[.nowap]
+------------------------
+>getAdoc /?
+getADoc /S|SepaDoc /I|Icons /SCREEN /F|Force /FreePage  /L|Lang  /T|Template  /SepaSubDoc /OpenAdocHelp /CopyDrawio   *
 * adocの雛形を作成します
  - /S|SepaDoc                 :分割ドキュメントの雛形
- - /O|OneDoc                  :埋め込み型1つのadoc雛形
  - /I|Icons                   :Custom ICONSs配置
  - /SCREEN                    :SCREEN GAロゴ入り
- - /Force                     :強制上書き
+ - /F|Force                   :強制上書き
+ - /FreePage        :ページサイズを固定しない。default=True(1)
+ - /L|Lang              :言語 ja or en。デフォルトはja
+ - /T|Template    :文書の雛形
+        Normal/Meeting/QnA/BasicDesign/TroubleReport から指定する。指定が無い場合はNormal
+        - Normal     通常(Normal)
+        - Meeting    議事録(Record of Proceedings)
+        - QA         Q&A
+        - BesicDesign   基本設計(Basic Design)
+        - TroubleReport 障害解析(Trouble Report)
+
+// Add 2024/11/27
+ - /OpenAdocHelp             : ascodoc記述のWebページを開く
+ - /CopyDrawio     : 1:コピーする、0:コピーしない、その他：その名前でファイルを作成する
+//
  - *                          :adocのファイル名称を指定します
-----
+
+ - /SepaSubDoc                 :(上位からは指定しない）分割ドキュメントのサブドキュメント雛形
+
+------------------------
 
 // end::sub[]
 END
diff --git a/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.html b/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.html
index 77db8a6..0e4faa3 100644
--- a/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.html
+++ b/Release/getADoc.Data/adocTPL/ReadMe/ReadMeAsciiDocTool.html
@@ -4,25 +4,23 @@
 
 
 
-
+
 ReadMe.AsciiDocTool
 
 
-
 
-
+
 
 

-

-
 

+

+

+

+

+

+

+

+

+
+
+

+

 

-
ReadMe.AsciiDocTool

-

+

 

-

-
2021/09/13 AP開発 松尾

+

+
2024/11/27 松尾：helpとdrawio追記

+2021/09/13 AP開発 松尾

+

+

 

 

 

-

+

 
1. 概要

 

-

+

 
AsciiDotの雛形を作るコマンドラインツールです。

 コマンドラインからgetAdoc.batを利用します。以下例です

 

-

+

 
    
-
  1. 
+
  2. 
 
    getAdoc <ドキュメント名>
    
 最小限の雛形を作成する。<ドキュメント名>.adocを作成。config.adocとImagesフォルダを作成します。
    
 
    3. 
-
  3. 
+
  4. 
 
    getAdoc /Icons <ドキュメント名>
    
 脚注アイコン(警告、注意など）をマニュアル風に変更します。
    
-
    
+
    
 
    
-
    
+
    
 
    t
    
 
    
 
    
 
    
 
    5. 
-
  5. 
+
  6. 
 
    getAdoc /Icons /SCREEN <ドキュメント名>
    
 脚注アイコンと共に、SCREEN GAのタイトルロゴ、Confidentialを頭に追記します。
    
-
    
+
    
 
    
-
    
+
    
 
    t
    
 
    
 
    
 
    
 
    7. 
-
  7. 
+
  8. 
 
    getAdoc /Icons /SCREEN /SepaDoc <ドキュメント名>
    
 分割ドキュメント形式の雛形を作成します。（フルセット）
    
-
    
+
    
 
    
-
    
+
    
 
    t
    
 
    
 
    
@@ -502,25 +663,41 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 
    
 
    
 
    
-
    
+
    
 
    2. ヘルプ
    
 
    
-
    
+
    
 
    コマンドラインからgetAdoc.bat /?で以下のヘルプを表示
    
 
    
-
    
+
    
 
    
-
    getADoc /S|SepaDoc /O|OneDoc /I|Icons /SCREEN /Force *
+
    >getAdoc /?
+getADoc /S|SepaDoc /I|Icons /SCREEN /F|Force /FreePage <FreePage> /L|Lang <Lang> /T|Template <TemplateName> /SepaSubDoc /OpenAdocHelp /CopyDrawio   *
 * adocの雛形を作成します
  - /S|SepaDoc                 :分割ドキュメントの雛形
- - /O|OneDoc                  :埋め込み型1つのadoc雛形
  - /I|Icons                   :Custom ICONSs配置
  - /SCREEN                    :SCREEN GAロゴ入り
- - /Force                     :強制上書き
+ - /F|Force                   :強制上書き
+ - /FreePage   <FreePage>     :ページサイズを固定しない。default=True(1)
+ - /L|Lang     <Lang>         :言語 ja or en。デフォルトはja
+ - /T|Template  <TemplateName>  :文書の雛形
+        Normal/Meeting/QnA/BasicDesign/TroubleReport から指定する。指定が無い場合はNormal
+        - Normal     通常(Normal)
+        - Meeting    議事録(Record of Proceedings)
+        - QA         Q&A
+        - BesicDesign   基本設計(Basic Design)
+        - TroubleReport 障害解析(Trouble Report)
+ - /SepaSubDoc                 :分割ドキュメントのサブドキュメント雛形(上位からは指定しない）
+
+ // Add 2024/11/27
+
+ - /OpenAdocHelp             : ascodoc記述のWebページを開く
+ - /CopyDrawio    <dioFName> : 1:コピーする、0:コピーしない、その他：その名前でファイルを作成する
+
  - *                          :adocのファイル名称を指定します
    
 
    
 
    
-
    
+
    
 
    END
    
 
    
 
    
@@ -528,7 +705,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 
    
 
 
diff --git a/Release/getADoc.Data/adocTPL/drawio_base/fig.drawio b/Release/getADoc.Data/adocTPL/drawio_base/fig.drawio
new file mode 100644
index 0000000..4224d8e
--- /dev/null
+++ b/Release/getADoc.Data/adocTPL/drawio_base/fig.drawio
@@ -0,0 +1,18 @@
+
+  
+    
+      
+        
+        
+      
+    
+  
+  
+    
+      
+        
+        
+      
+    
+  
+
diff --git a/Release/getADoc.Data/getADoc.bat b/Release/getADoc.Data/getADoc.bat
index c1c59b2..75e0bcd 100644
--- a/Release/getADoc.Data/getADoc.bat
+++ b/Release/getADoc.Data/getADoc.bat
@@ -65,11 +65,17 @@ var pm = uParam()
  	//
 	// `
 	.set("TemplateName").opt("/T|Template").next("*")  .init("Normal")   .desc("̐`"+getTemplateHelp())
-	.set("bSepaSubDoc")   .opt("/SepaSubDoc")            .init(false).desc("hLg̃TuhLg`(ʂ͎w肵Ȃj")
+
+	//
+	.set("OpenAdocHelp").opt("/OpenAdocHelp") 				.init(false) .desc("asciidoc̋LqwvJ")
+	.set("CopyDrawio")   .opt("/CopyDrawio").next("*")      .init(0)	.desc("drawiot@C쐬B0:쐬ȂA1:쐬B̑Fdrawiõt@C")
 
 	// ŒFunnamedƑŜ̐Lq
     .set("*")    .desc("adoc̃t@Ĉw肵܂")
     .set("usage").desc("adoc̐`쐬܂")
+
+	.set("bSepaSubDoc")   .opt("/SepaSubDoc")            .init(false).desc("(ʂ͎w肵Ȃ) hLg̃TuhLg`")
+
 	.read();
 
 // [Main process] Lq
@@ -111,6 +117,7 @@ var conf = {
 	,adocTemplateSepa:"tmpl_Normal\\TemplateSeparateDocRoot.adoc"
 	,adocSepaIncDoc:"IncDoc.adoc"
 	,logosDir:"Logos"
+
 	// Template̒lj
 
 
@@ -160,6 +167,13 @@ if ( pm.length > 0 ){
 // 쐬̃tH_
 var tgtDir = adocPath.PR();
 
+// htmlwv\ďI
+if (pm.OpenAdocHelp) {
+	var helpPath = makePath(conf.tplDir,"HtmlHelp","AdocȈՐhelp.html");
+	// echo("helpPath=",helpPath);
+	doCmd( {echo:false}, helpPath);
+	exit(0);
+}
 // config̃Rs[
 var tgtconfigPath = makePath(adocPath.PR(),configPath.FN());
 
@@ -202,6 +216,12 @@ if ( pm.bICONs ){
 	doCmd({echo:false},"copy",srcIconDir.down("*.*"),tgtIconDir);
 }
 
+var drawioPath = makePath(conf.tplDir,"drawio_base","fig.drawio");
+
+if ( isOk(pm.CopyDrawio) ) {
+	saftyCopy(drawioPath,adocPath.PR(),pm.CopyDrawio);
+}
+
 // Create adoc.
 if ( !pm.bSepaDoc ) { 
 	if ( configPathTemplate.isExistFile() ) {
@@ -303,6 +323,10 @@ if ( pm.bSepaDoc ) {
 			cmdVec.push("/Template");
 			cmdVec.push( pm.TemplateName );
 		}
+		if ( pm.CopyDrawio ) {
+			cmdVec.push("/CopyDrawio");
+			cmdVec.push( pm.CopyDrawio );		
+		}
 		// TuhLg
 		cmdVec.push( subDir.down(subName) );
 		doCmd(cmdVec); // getAdoc.baťĂяo
@@ -323,6 +347,33 @@ function copySure(f) {
 	return true;
 }
 
+/*
+ 	݂Ζ̂ςăRs[
+*/
+function saftyCopy(srcPath,destDir,fname) {
+	if ( fname == true || fname == 1 || fname == undefined) {
+		fname= srcPath.FN()
+	}
+	fname = castS(fname);
+	if ( isNone(fname.EX() ) ) {
+		fname += ("."+srcPath.EX());
+	}
+	var dstPath= makePath( destDir, isOk(fname) ? fname : srcPath.FN() );
+	if ( !dstPath.isExistFile() ) {
+		copyFile(srcPath,dstPath);
+		return 0;
+	}
+	var bn = dstPath.BN();
+	for(var i=1; i<100;i++) {
+		var newPath = dstPath.BN(bn+"("+i+")");
+		if ( !newPath.isExistFile() ) {
+			copyFile(srcPath,newPath);
+			return 0;
+		}
+	}
+	return -1;
+}
+
 // ȉ͐΂ɍ폜Ă͂Ȃ
 
 // DO-NOT-EDIT START@69cf47e2-4a1f-459c-9803-c97a999a70c2
-- 
2.22.0