Commit a7424ecf authored by AP matsuo koji's avatar AP matsuo koji 😲

update adoc pub

parent f383e673
// サブドキュメント化のマクロ // サブドキュメント化のマクロ
ifndef::IncDocDir[] ifndef::IncDocDir[]
:IncDocDirTmp: {IncDocName} :IncDocDirTmp: {IncDocName}
endif::[] endif::[]
...@@ -14,56 +15,125 @@ ifndef::IncDocLvl[] ...@@ -14,56 +15,125 @@ ifndef::IncDocLvl[]
:IncDocLvl: +2 :IncDocLvl: +2
endif::[] endif::[]
// タグが定義されていたらその範囲を取り込む
ifdef::IncDocTag[]
include::./{IncDocDirTmp}/{IncDocName}.adoc[tag={IncDocTag},leveloffset={IncDocLvl}] include::./{IncDocDirTmp}/{IncDocName}.adoc[tag={IncDocTag},leveloffset={IncDocLvl}]
//include::./{IncDocDir}/{IncDocName}.adoc[leveloffset={IncDocLvl}] endif::[]
// タグが無い場合は、サブドキュメント全体を取り込む
ifndef::IncDocTag[]
include::./{IncDocDirTmp}/{IncDocName}.adoc[leveloffset={IncDocLvl}]
endif::[]
// restore // restore
:imagesdir: {imagesdir_back} :imagesdir: {imagesdir_back}
//// ////
ルートドキュメント側の記述方法
(サブドキュメントには不要) // tag::HelpSeparationDoc[]
.##分離ドキュメントのヘルプです (行削除)##
:IncDocName: <ドキュメント名> [%collapsible]
// [必須] インクルードする<ドキュメント名>を指定。 =============================================
// 実際のファイルは<ドキュメント名>.adoc と拡張子をつけること。 ========================
.◆分離ドキュメント構成の雛形です
:IncDocDir: <ディレクトリ名> 画像ディレクトリは各ドキュメントの"Images"ディレクトリに固定。
// [省略可] インクルードする<ディレクトリ名>を指定。 ----
// 省略した場合は<ドキュメント名>が<ディレクトリ名> になる。 TemplateSeparateDocRoot.adoc
├─ Sub_First
:IncDocLvl: <レベル> │ │ config.adoc
// [省略可] ドキュメントレベルを+Nで指定する。 │ │ Sub_First.adoc
// タイトル行の"="のレベルを下げることができる +2を指定すると、"="が"==="として │ └─Images
// Includeされる。省略値は +2。
└─ Sub_Second
include::IncDoc.adoc[] │ config.adoc
// [必須] ドキュメントをインクルードする。固定記述。 │ Sub_Second.adoc
└─Images
例.最小限 ----
--- root.adoc --------
:IncDocName: SubDocFirst .◆ルートドキュメント側の記述方法
include::IncDoc.adoc[] サブドキュメントには不要。サブドキュメントのインクルード毎に記述する
----------------------
root.adoc ``:IncDocName: <サブドキュメント名>``: ::
+-- SubDocFirst\ [必須] インクルードする<サブドキュメント名>を指定。
+ SubDocFirst.adoc 実際のファイルは<サブドキュメント名>.adoc と拡張子をつけること。
例.カスタム ``include::IncDoc.adoc[]``: ::
--- root.adoc -------- [必須] サブドキュメントをインクルードする場所。固定記述。
:IncDocDir: 01_Func
:IncDocLvl: +2 ``:IncDocDir: <ディレクトリ名>``: ::
// ... [省略可] インクルードする<ディレクトリ名>を指定。
:IncDocName: SubDocFirst 省略した場合は<サブドキュメント名>が<ディレクトリ名> になる。
include::IncDoc.adoc[]
``:IncDocLvl: <レベル>``: ::
:IncDocName: SubDocSecond [省略可] サブドキュメントレベルを+Nで指定する。
include::IncDoc.adoc[] タイトル行の"="のレベルを下げることができる +2を指定すると、"="が"==="としてIncludeされる。省略値は +2。
----------------------
サブドキュメントを01_Func\SubDocFirst.adocとSubDocSecond.adocを配置 ``:IncDocTag: sub``: ::
root.adoc [省略可] サブドキュメントの取り出し範囲を指定します。サブドキュメント側タグ属性``sub[]``の領域を取り込む。
省略した場合、サブドキュメント全体を取り込みます。
.◆サブドキュメント側の記述
サブドキュメントは通常のAsciiDocの記述。
取り込み範囲を指定したい場合はルートドキュメント側``:IncDocTag: sub``指定に合わせて、以下のタグを指定する。
記述が無い場合、全体を取り組む。タグ名(sub)を変更すれば、別の範囲も取り込み可能。
----
// サブドキュメントの取り込み範囲
// tag::sub[]
... 取り込みたい部分
// end::sub[]
----
.◆例 ルートドキュメント側
例.最小限: フォルダ名とサブドキュメント名が同一::
+
----
--- root.adoc --------
= Root title
...
== First SubDocument
:IncDocName: Sub_First
include::IncDoc.adoc[]
== Second SubDocument
:IncDocName: Sub_Second
include::IncDoc.adoc[]
----------------------
root.adoc
+-- Sub_First\
+ Sub_First.adoc
+ confing.adoc
+-- Sub_Second\
+ Sub_Second.adoc
+ confing.adoc
----
例.カスタム: ディレクトリ名変更::
+
----
--- root.adoc --------
= Root title
...
:IncDocDir: 01_Func
:IncDocLvl: +2
== First SubDocument
:IncDocName: Sub_First
include::IncDoc.adoc[]
== Second SubDocument
:IncDocName: Sub_Second
include::IncDoc.adoc[]
----------------------
サブドキュメントを01_FuncフォルダにSub_First.adocとSub_Second.adocを配置
root.adoc
+-- 01_Func\ +-- 01_Func\
+ SubDocFirst.adoc + Sub_First.adoc
+ SubDocSecod.adoc + Sub_Second.adoc
----
========================
=============================================
// end::HelpSeparationDoc[]
//// ////

: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
= ReadMe.AsciiDocTool
[.text-right]
--
2021/09/13 AP開発 松尾
--
// tag::sub[]
== 概要
AsciiDotの雛形を作るコマンドラインツールです。
コマンドラインからgetAdoc.batを利用します。以下例です
. ``getAdoc <ドキュメント名>``
最小限の雛形を作成する。<ドキュメント名>.adocを作成。config.adocとImagesフォルダを作成します。
. ``getAdoc /Icons <ドキュメント名>``
脚注アイコン(警告、注意など)をマニュアル風に変更します。
+
====
image:cicon.png[t,600]
====
. ``getAdoc /Icons /SCREEN <ドキュメント名>``
脚注アイコンと共に、SCREEN GAのタイトルロゴ、Confidentialを頭に追記します。
+
====
image:screenForm.png[t,600]
====
. ``getAdoc /Icons /SCREEN /SepaDoc <ドキュメント名>``
分割ドキュメント形式の雛形を作成します。(フルセット)
+
====
image:tree.png[t,200]
====
== ヘルプ
コマンドラインからgetAdoc.bat /?で以下のヘルプを表示
----
getADoc /S|SepaDoc /O|OneDoc /I|Icons /SCREEN /Force *
* adocの雛形を作成します
- /S|SepaDoc :分割ドキュメントの雛形
- /O|OneDoc :埋め込み型1つのadoc雛形
- /I|Icons :Custom ICONSs配置
- /SCREEN :SCREEN GAロゴ入り
- /Force :強制上書き
- * :adocのファイル名称を指定します
----
// end::sub[]
END
//////////////////////////////////////////////////////////////
// tag::CONFIG[] ↓↓ここからメイン文書に差し込み
:hardbreaks:
:imagesdir: Images
:doctype: article
:toclevels: 3
:sectnums:
:sectnumlevels: 4
:sectlinks:
:icons: font
:data-uri:
:experimental:
ifeval::["{lang}" == "ja"]
:toc-title: 目次
:example-caption:
: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::[]
ifeval::["{lang}" != "ja"]
:example-caption:
:caption:
endif::[]
// Macro
:experimental:
:ExtendStyle: pass:none[ \
<style> \
.nw{display:inline-block;white-space:pre;} \
.nowrap{display:inline-block;white-space:pre;} \
</style>]
// obsolate
:NoWrap: pass:[<span style="display:inline-block;white-space:pre;">]
:Wrap: pass:[<span style="display:inline;white-space:pre;">]
:End: pass:[</span>]
:br: pass:p[ +]
// end::CONFIG[] ↑↑ここまでメイン文書に差し込み
//////////////////////////////////////////////////////////////
...@@ -2,48 +2,53 @@ ...@@ -2,48 +2,53 @@
:lang: ja :lang: ja
include::config.adoc[] include::config.adoc[]
:toc!: :toc!:
:hardbreaks:
= @FILENAME@ = //@ICON_CUSTOM@
雛形:分離ドキュメントのルートファイル {ExtendStyle}
// After need empty-one-line
以下の構成で分離したドキュメント構成の雛形です。 //@SCREEN_LOGOS@
* 画像ディレクトリは各ドキュメントの"Images"ディレクトリ固定 // セクション取り込みレベル
:IncDocLvl: +2
// 取り込み範囲
:IncDocTag: sub
---- = @FILENAME@ =
TemplateSeparateDocRoot.adoc [.text-right]
├─ Sec1_FirstSubDoc --
│ │ config.adoc @DATE@
│ │ FirstSub.adoc --
│ └─Images
└─ Sec2_SecondSubDoc
│ config.adoc
│ SecondSub.adoc
└─Images
----
:IncDocLvl: +1 // ↓↓↓分離ドキュメントのヘルプ。コメントアウト もしくは行削除のこと
==== include::incDoc.adoc[tag=HelpSeparationDoc]
サブドキュメントのレベルは共通して{IncDocLvl}を設定(IncDocLvl: {IncDocLvl})。 // ↑↑↑
つまり、サブドキュメント内の"="で記載された部分が"=="で表現される
====
//======================================================================= //=======================================================================
:IncDocDir: Sec1_FirstSubDoc
:IncDocName: FirstSub == First SubDocument
// 省略可能
// :IncDocDir: Sub_First_Dir
// :IncDocTag: sub
//
:IncDocName: Sub_First
include::IncDoc.adoc[] include::IncDoc.adoc[]
//======================================================================= //=======================================================================
:IncDocDir: Sec2_SecondSubDoc == Second SubDocument
:IncDocName: SecondSub // 省略可能
// :IncDocDir: Sub_Second_Dir
// :IncDocTag: sub
//
:IncDocName: Sub_Second
include::IncDoc.adoc[] include::IncDoc.adoc[]
== ルートドキュメントの文末 == ルートドキュメントの文末
ルートドキュメントの最後です ルートドキュメントの最後です
//@ICON_SAMPLE@
END END
...@@ -53,11 +53,26 @@ endif::[] ...@@ -53,11 +53,26 @@ endif::[]
// HTML出力で画像を埋め込む // HTML出力で画像を埋め込む
:data-uri: :data-uri:
// 各種Macro拡張 // 各種Macro拡張
:hardbreaks:
:experimental: :experimental:
// Macro {NoWrap}...hoge hoge...{End} で自動改行しない
// Style拡張 [.XXXX]##hogehoge##で使用できる。{ExtendStyle}を表題の直前に記述する
// 属性の前に記載してはいけない。toc: leftなどが無効になる
// 拡張: [.nw]## <自動改行無効、複数空白文字OK> ## .nowrapでもOK。Tableの表幅調整に使用
:ExtendStyle: pass:none[ \
<style> \
.nw{display:inline-block;white-space:pre;} \
.nowrap{display:inline-block;white-space:pre;} \
</style>]
// obsolate
:NoWrap: pass:[<span style="display:inline-block;white-space:pre;">] :NoWrap: pass:[<span style="display:inline-block;white-space:pre;">]
:Wrap: pass:[<span style="display:inline;white-space:wrap;">] :Wrap: pass:[<span style="display:inline;white-space:pre;">]
:End: pass:[</span>] :End: pass:[</span>]
// 改行 {br}
:br: pass:p[ +]
//// ////
#### COMENT START ################# #### COMENT START #################
------------------------------------------------------------------ ------------------------------------------------------------------
......
This source diff could not be displayed because it is too large. You can view the blob instead.
...@@ -7,18 +7,32 @@ include::config.adoc[] ...@@ -7,18 +7,32 @@ include::config.adoc[]
//:toc: left //:toc: left
//:imagesdir: Images //:imagesdir: Images
:hardbreaks: //@ICON_CUSTOM@
= @FILENAME@ = {ExtendStyle}
// After need empty-one-line
== 第1章 //@SCREEN_LOGOS@
= @FILENAME@
[.text-right]
--
@DATE@
--
// tag::sub[]
== Summary
最初の文書です。 最初の文書です。
* [x] チェックボックス [*] or [ ] * [x] チェックボックス [*] or [ ]
== 第2章 //@ICON_SAMPLE@
== Detail
ほげ ほげ
以上 以上
// end::sub[]
:lang: ja
:docname: @FILENAME@
:conf: {docname}.adoc
include::{conf}[tag="CONFIG"}]
//:toc: left
//@ICON_CUSTOM@
{ExtendStyle}
// After need empty-one-line
//@SCREEN_LOGOS@
= @FILENAME@
[.text-right]
--
@DATE@
--
// tag::sub[]
== Summary
最初の文書です。
//@ICON_SAMPLE@
== Detail
// end::sub[]
// END
//////////////////////////////////////////////////////////////
// tag::CONFIG[] ↓↓ここからメイン文書に差し込み
:hardbreaks:
:imagesdir: Images
:doctype: article
:toclevels: 3
:sectnums:
:sectnumlevels: 4
:sectlinks:
:icons: font
:data-uri:
:experimental:
ifeval::["{lang}" == "ja"]
:toc-title: 目次
:example-caption:
: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::[]
ifeval::["{lang}" != "ja"]
:example-caption:
:caption:
endif::[]
// Macro
:experimental:
:ExtendStyle: pass:none[ \
<style> \
.nw{display:inline-block;white-space:pre;} \
.nowrap{display:inline-block;white-space:pre;} \
</style>]
// obsolate
:NoWrap: pass:[<span style="display:inline-block;white-space:pre;">]
:Wrap: pass:[<span style="display:inline;white-space:pre;">]
:End: pass:[</span>]
:br: pass:p[ +]
// end::CONFIG[] ↑↑ここまでメイン文書に差し込み
//////////////////////////////////////////////////////////////
This source diff could not be displayed because it is too large. You can view the blob instead.
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