diff --git a/Doc/Images/.$images.drawio.bkp b/Doc/Images/.$images.drawio.bkp new file mode 100644 index 0000000000000000000000000000000000000000..33939aa36cb9875ca7427d882784ef8cf22ed9f5 --- /dev/null +++ b/Doc/Images/.$images.drawio.bkp @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Doc/Images/FIleNameForcus.png b/Doc/Images/FIleNameForcus.png new file mode 100644 index 0000000000000000000000000000000000000000..64db9c03dc4df47b2922f024fadcab3cb8f00fa5 Binary files /dev/null and b/Doc/Images/FIleNameForcus.png differ diff --git a/Doc/Images/GUI_Image.png b/Doc/Images/GUI_Image.png new file mode 100644 index 0000000000000000000000000000000000000000..4936366b1f56c6fa10e5f1238175ceb4c86f6374 Binary files /dev/null and b/Doc/Images/GUI_Image.png differ diff --git a/Doc/Images/GUI_Image_Detail.png b/Doc/Images/GUI_Image_Detail.png new file mode 100644 index 0000000000000000000000000000000000000000..0f2afc3d7a07a7de9c49ff09c1b820ac1cff0f76 Binary files /dev/null and b/Doc/Images/GUI_Image_Detail.png differ diff --git a/Doc/Images/HelpPage.png b/Doc/Images/HelpPage.png new file mode 100644 index 0000000000000000000000000000000000000000..411da8e99b1d8cfbc92ea1a91e974272c004ba3a Binary files /dev/null and b/Doc/Images/HelpPage.png differ diff --git a/Doc/Images/Help_Button.png b/Doc/Images/Help_Button.png new file mode 100644 index 0000000000000000000000000000000000000000..e5aa8b390b4de0656046404c55747553cda3ae7f Binary files /dev/null and b/Doc/Images/Help_Button.png differ diff --git a/Doc/Images/Inst-cmd-run.png b/Doc/Images/Inst-cmd-run.png new file mode 100644 index 0000000000000000000000000000000000000000..c0531ef43b5800c6642b88b8ac2d22bb4a95d6f6 Binary files /dev/null and b/Doc/Images/Inst-cmd-run.png differ diff --git a/Doc/Images/Inst-cmd.png b/Doc/Images/Inst-cmd.png new file mode 100644 index 0000000000000000000000000000000000000000..4d838c1ea9c66829555503ac41f051a75b43e89b Binary files /dev/null and b/Doc/Images/Inst-cmd.png differ diff --git a/Doc/Images/Template.dio.png b/Doc/Images/Template.dio.png new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/Doc/Images/V200UI.png b/Doc/Images/V200UI.png new file mode 100644 index 0000000000000000000000000000000000000000..d4f29a7356c93715807f7797790baef0a8510c1e Binary files /dev/null and b/Doc/Images/V200UI.png differ diff --git a/Doc/Images/V300UI.png b/Doc/Images/V300UI.png new file mode 100644 index 0000000000000000000000000000000000000000..e006545b1571abc4a64da5c218cdf09cafe04128 Binary files /dev/null and b/Doc/Images/V300UI.png differ diff --git a/Doc/Images/arg_run.png b/Doc/Images/arg_run.png new file mode 100644 index 0000000000000000000000000000000000000000..c384a670049129e26d662ccc7034ed79e4747567 Binary files /dev/null and b/Doc/Images/arg_run.png differ diff --git a/Doc/Images/bunkatsu.png b/Doc/Images/bunkatsu.png new file mode 100644 index 0000000000000000000000000000000000000000..baa19e85690e742962dc47ce080da5bfd99897fc Binary files /dev/null and b/Doc/Images/bunkatsu.png differ diff --git a/Doc/Images/cmd_arg.png b/Doc/Images/cmd_arg.png new file mode 100644 index 0000000000000000000000000000000000000000..0fbad533304b3b6c247c580fed1477f79221ef06 Binary files /dev/null and b/Doc/Images/cmd_arg.png differ diff --git a/Doc/Images/comp.png b/Doc/Images/comp.png new file mode 100644 index 0000000000000000000000000000000000000000..fb2905b14c6a3a89a3214da3fc8446fb48d793ec Binary files /dev/null and b/Doc/Images/comp.png differ diff --git a/Doc/Images/dragAndDrop.png b/Doc/Images/dragAndDrop.png new file mode 100644 index 0000000000000000000000000000000000000000..efac57185072c3ea48ebadf91f2c3943a684625c Binary files /dev/null and b/Doc/Images/dragAndDrop.png differ diff --git a/Doc/Images/drawio_cb.png b/Doc/Images/drawio_cb.png new file mode 100644 index 0000000000000000000000000000000000000000..1853687bc7bcb3e8f4a497fdc088daa0c2430c62 Binary files /dev/null and b/Doc/Images/drawio_cb.png differ diff --git a/Doc/Images/drawio_output.png b/Doc/Images/drawio_output.png new file mode 100644 index 0000000000000000000000000000000000000000..951e0daca36722d23ef32a9c95a860d427504657 Binary files /dev/null and b/Doc/Images/drawio_output.png differ diff --git a/Doc/Images/explorer-image.png b/Doc/Images/explorer-image.png new file mode 100644 index 0000000000000000000000000000000000000000..ed7504b79706d31471d2e1b87cc79c351caf3da5 Binary files /dev/null and b/Doc/Images/explorer-image.png differ diff --git a/Doc/Images/icon.png b/Doc/Images/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..84405d0a4b82148a395f0fd7f3a01cf5e93fe05b Binary files /dev/null and b/Doc/Images/icon.png differ diff --git a/Doc/Images/images-Jp-En.png b/Doc/Images/images-Jp-En.png new file mode 100644 index 0000000000000000000000000000000000000000..a534de6d6779cb300fc85e35602bbec7d1fda02b Binary files /dev/null and b/Doc/Images/images-Jp-En.png differ diff --git a/Doc/Images/images-V200-Option.png b/Doc/Images/images-V200-Option.png new file mode 100644 index 0000000000000000000000000000000000000000..1401285a665f0c257782944a84f0b55ce9bf2847 Binary files /dev/null and b/Doc/Images/images-V200-Option.png differ diff --git a/Doc/Images/images-V200.png b/Doc/Images/images-V200.png new file mode 100644 index 0000000000000000000000000000000000000000..0bf60558e054e02d287e4b2bca46818c1a0d25d0 Binary files /dev/null and b/Doc/Images/images-V200.png differ diff --git a/Doc/Images/images.drawio b/Doc/Images/images.drawio new file mode 100644 index 0000000000000000000000000000000000000000..a9f541d1ee9605136045897c19157a34d10ece03 --- /dev/null +++ b/Doc/Images/images.drawio @@ -0,0 +1,133 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Doc/Images/logo.png b/Doc/Images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..431ad7cf877951dfd6c631d49fdeb0f5b3d2051c Binary files /dev/null and b/Doc/Images/logo.png differ diff --git a/Doc/Images/sansyou.png b/Doc/Images/sansyou.png new file mode 100644 index 0000000000000000000000000000000000000000..761fb59303e442d51504d1111076e9d0e62eb2c8 Binary files /dev/null and b/Doc/Images/sansyou.png differ diff --git a/Doc/Images/savePath.png b/Doc/Images/savePath.png new file mode 100644 index 0000000000000000000000000000000000000000..815c7e29e6d9c7666918fdac71c2a7924ad8e681 Binary files /dev/null and b/Doc/Images/savePath.png differ diff --git a/Doc/Images/save_button.png b/Doc/Images/save_button.png new file mode 100644 index 0000000000000000000000000000000000000000..9c24dca33887d293d30b70cf2d9a64947c01d40b Binary files /dev/null and b/Doc/Images/save_button.png differ diff --git a/Doc/Images/savecheck.png b/Doc/Images/savecheck.png new file mode 100644 index 0000000000000000000000000000000000000000..40b088b9dbf49a25c79f0fb6cebafc82df9cdf2b Binary files /dev/null and b/Doc/Images/savecheck.png differ diff --git a/Doc/Images/selecter-format.png b/Doc/Images/selecter-format.png new file mode 100644 index 0000000000000000000000000000000000000000..787cb9d183f0255d89013e770155b3d6e0e69b60 Binary files /dev/null and b/Doc/Images/selecter-format.png differ diff --git a/Doc/ReadMe.adoc b/Doc/ReadMe.adoc new file mode 100644 index 0000000000000000000000000000000000000000..a8c935b5a7fa9ac21cfd3d340d9f0935496752d0 --- /dev/null +++ b/Doc/ReadMe.adoc @@ -0,0 +1,174 @@ + +:lang: ja +include::config.adoc[] +// custom css. +//:stylesdir: ./ +//:stylesheet: edit.css +:toc: left +:freepage: +//:imagesdir: Images + +// Custom Icons(J) +//:icons: image +//:iconsdir: icons +//:icontype: png +// + +{ExtendStyle} +// After need empty-one-line + + + += ReadMe:AsciiDoc雛形生成ツール +[.text-right] +-- +2021/07/10 +-- +// tag::sub[] + +== Summary +AsciiDoc文書(以下ADocと表記)の雛形を作るツールの説明資料です。 + +//image:GUI_Image.png[] +.ツールGUI +image:V300UI.png[] +//image:V200UI.png[] + +.更新履歴 +[cols="a,a,a", options="header, autowidth"] +|=== +| Ver1.0.0 | 2021//7/10 |初版 +| Ver1.1.0 | 2021/12/24 |Path保存機能を追加 +| Ver1.1.1 | 2023/7/6 |1.2.0に向け、CLI起動オプションを追加 +| Ver1.2.0 | 2023/7/7 |右クリックショートカット追加 +| Ver2.0.0 | 2023/9/13 |GUI更新、雛形フォーマット追加 +| Ver3.0.0 | 2024/11/28|GUI更新、drawio作成、ヘルプページOPEN追加 +|=== + +== Detail + +=== Ver 3.0.0 + +* GUI更新 +. HELPボタン追加 +image:Help_Button.png[*,150] +Helpボタンの機能を追加。クリックするとデフォルトに設定しているブラウザで、html形式で記述されたHELPページが開かれます。 +image:HelpPage.png[] +. Drawioオプション追加 +image:drawio_cb.png[*,150] +オプションメニューにdrawioファイルを一緒に作成する機能を追加しました。チェックボックスをONにして作成ボタンを押下すると、以下の様に「fig.drawio」というdrawioファイルがADocと同階層に作成されます。 +image:drawio_output.png[*,400] +. 保存Path廃止 +Pathを1つ記憶する機能を廃止し、UI上の「保存Path」のチェックボックスimage:savecheck.png[*,80*]を削除しました。右クリックのショートカットで、エクスプローラで開いているフォルダからアプリを開けるようになり、Path情報を維持するメリットが薄くなったためです。 +* 修正 +. アプリ起動時、ドキュメント名のボックスにフォーカスされるように修正 +アプリを起動した際、以下の様にドキュメント名を指定するテキストボックスへフォーカスされるように修正しました。右クリックのショートカット等で、フォルダが指定されている状態であれば、アプリを開いてすぐ、キーボード操作でファイル名を指定いただけます。 +image:FIleNameForcus.png[[*,500] + +=== Ver 2.0.0 + +* GUIに機能を追加 +. 文書フォーマット選択 +用途に応じた文書フォーマットを出力できます。また、フォーマットは後に紹介する言語切替で、日本語と英語それぞれで出力できます。(##※一部フォーマットは英語未対応##) +image:selecter-format.png[] +フォーマット:: +- ノーマル/Normal +一番シンプルで自由度の高いフォーマットです。 +- QnA +QnA用のフォーマットです。QnA番号やその回答用のボックスなどの記述例が予め記述されています。 +- 基本設計資料 / Basic Design +基本設計資料用のフォーマットです。対応項目のテーブル等が用意されています。SCREENロゴや分割ドキュメントのオプションを加えた出力で、過去の基本設計で作成していたような文書が作成できます。 +- 議事録 / record of Proceedings +議事録用のフォーマットです。開催情報や会議結果、AIといった会議用の記載欄が用意されています。 + +. 日英言語切替 +UIの表示言語と出力ファイルの記述を日本語と英語で切り替えます。トグルボタンの切替により変更可能です。(※一部フォーマットは英語未対応で、日本語の記述で出力されます。お手数ですが、適宜修正下さい。) +image:images-Jp-En.png[] + +. フリーページ +ページ幅を可変にするオプションです。付加すると文書冒頭の定義に、``:FreePage:``という文言が加わります。解除したい場合は、定義を``:!FreePage:``とすると設定が無効になります。 +image:images-V200-Option.png[] + +. 右クリックショートカット追加ボタン +Ver1.2.0で対応した、右クリックショートカットのインストールをGUI上で実行できます。 +##※もしGUI上でインストールに失敗した場合は、<>の手順で手動インストールください。## + +=== Ver 1.2.0 + +* explorerの右クリックメニューから、ツールを起動できるように改良 + +インストール手順:: +. GetADoc_GUI_1.2.0.zipを回答し、Ver 1.2.0のツールを配置する。 +. ツールのフォルダでコマンドラインを起動する。 +image:Inst-cmd.png[] +. コマンドラインで以下のコマンドを実行する。 +`InstAdocUI.js.bat /Inst` +image:Inst-cmd-run.png[] +. 変更許可のダイアログが表示された場合は、許可を選択します。 +. 処理の完了後、explorer上で右クリックを行い、以下のメニュー(赤枠)が追加されていれば、インストールは完了です。 +image:explorer-image.png[] + +動作:: +. 雛形を作成したいPathをexplorerで開きます。 +. explorer上で右クリックを行い、メニューから「GetADocUI」を開きます。 +. ツールのフォルダ指定メニューに、「1.」で開いていたexplorerのPathが入力された状態で、ツールが起動します。 + + +=== ver 1.1.1 + +* コマンドラインで起動する際に、第一引数にPahtを指定すると、そのpathを「作成先のフォルダ」に設定した状態でツールを起動する昨日を追加 ++ +.入力例 +image:cmd_arg.png[] ++ +.起動時 +image:arg_run.png[] + +=== ver 1.1.0 + +* 1つのPathを記憶できる機能を追加 +image:savecheck.png[*,80*]にチェックをいれると、記憶しているPathをテキストボックスに自動入力します。チェックをOFFにすると、前回指定したPathに切り替わります。 +Pathの登録方法:: +1. image:savecheck.png[*,80*]にチェックを入れます。 +2. 未登録の場合、以下のメッセージが出力されます。 +image:savePath.png[] +3. チェックをONにした状態で、任意のフォルダを設定し、ADocファイルを生成します。 +4. 生成処理が完了すると、チェックボックス横にPathの登録(更新)が完了したことを伝えるメッセージが表示されます。以上で、Pathの登録(更新)は完了です。次回以降、チェックボックスをON/OFFで、登録したPathを読み込められるようになります。 + +=== ver 1.0.0 + +//image:GUI_Image_Detail.png[] +image:images-V200.png[] + +1. 出力先フォルダの指定メニュー +ADocファイルの出力先を指定するメニューです以下の手順で設定できます。 +* ファイル参照ボタン +image:sansyou.png[*,55*]ボタンをクリックすると、エクスプローラー形式のフォルダ選択メニューが表示されます。そこから任意のフォルダを選択することが出来ます。 +* エクスプローラーからのドラッグ&ドロップ +エクスプローラー上からGetADocGUI上にフォルダをドラッグし、マウスカーソルが「+」のアイコンになっているタイミングでドロップすると、該当フォルダのフルPathがテキストボックスに自動入力されます。 +image:dragAndDrop.png[] + +2. ファイル名入力メニュー +出力するADocファイルのファイル名を入力します。 + +3. SCREENロゴの有無 +チェックボックスをONにすると、ドキュメント上部にSCREENのロゴと「Confidential」を記載したドキュメントを出力します。 +image:logo.png[] + +4. カスタムアイコン +チェックボックスをONにすると、ドキュメント上の注釈アイコン(警告、注意など)をADocオリジナルのものから、マニュアル風に変更します。 +image:icon.png[] + +5. 分割ドキュメント +分割ドキュメント形式のADoc雛形を作成します。(フルセット) +image:bunkatsu.png[] + +6. 作成 +クリックすると、上記のメニューで指定した内容でADocファイルを出力します。完了すると以下のメッセージがUI上に表示されます。 +image:comp.png[] + + +以上 +// end::sub[] + + diff --git a/Doc/config.adoc b/Doc/config.adoc new file mode 100644 index 0000000000000000000000000000000000000000..2961955d056a07bea15c61443cf21b4b5d893a3a --- /dev/null +++ b/Doc/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[] +