ReadMe：AsciiDoc雛形生成ツール

2021/07/10

1. Summary

AsciiDoc文書（以下ADocと表記）の雛形を作るツールの説明資料です。

ツールGUI

V300UI

更新履歴
Version 日付 内容

Ver3.0.1

2026/01/25-03/19

微修正

Ver3.0.0

2024/11/28

GUI更新、drawio作成、ヘルプページOPEN追加

Ver2.0.0

2023/9/13

GUI更新、雛形フォーマット追加

Ver1.2.0

2023/7/7

右クリックショートカット追加

Ver1.1.1

2023/7/6

1.2.0に向け、CLI起動オプションを追加

Ver1.1.0

2021/12/24

Path保存機能を追加

Ver1.0.0

2021//7/10

初版

2. Detail

2.1. Ver 3.0.1

  • doctypeをbookからarticleに初期値を変更

  • GitLabで不要な文字列が表示されないようにした（ htmlパススルーで無効になった記述を表示しないようにした

2.2. Ver 3.0.0

  • GUI更新

    1. HELPボタン追加
      *
      Helpボタンの機能を追加。クリックするとデフォルトに設定しているブラウザで、html形式で記述されたHELPページが開かれます。
      HelpPage

    2. Drawioオプション追加
      <strong>
      オプションメニューにdrawioファイルを一緒に作成する機能を追加しました。チェックボックスをONにして作成ボタンを押下すると、以下の様に「fig.drawio」というdrawioファイルがADocと同階層に作成されます。
      </strong>

    3. 保存Path廃止
      Pathを1つ記憶する機能を廃止し、UI上の「保存Path」のチェックボックス<strong>を削除しました。右クリックのショートカットで、エクスプローラで開いているフォルダからアプリを開けるようになり、Path情報を維持するメリットが薄くなったためです。

  • 修正

    1. アプリ起動時、ドキュメント名のボックスにフォーカスされるように修正
      アプリを起動した際、以下の様にドキュメント名を指定するテキストボックスへフォーカスされるように修正しました。右クリックのショートカット等で、フォルダが指定されている状態であれば、アプリを開いてすぐ、キーボード操作でファイル名を指定いただけます。
      [*

2.3. Ver 2.0.0

  • GUIに機能を追加

    1. 文書フォーマット選択
      用途に応じた文書フォーマットを出力できます。また、フォーマットは後に紹介する言語切替で、日本語と英語それぞれで出力できます。（※一部フォーマットは英語未対応）
      selecter format

      フォーマット

      • ノーマル/Normal
        一番シンプルで自由度の高いフォーマットです。

      • QnA
        QnA用のフォーマットです。QnA番号やその回答用のボックスなどの記述例が予め記述されています。

      • 基本設計資料 / Basic Design
        基本設計資料用のフォーマットです。対応項目のテーブル等が用意されています。SCREENロゴや分割ドキュメントのオプションを加えた出力で、過去の基本設計で作成していたような文書が作成できます。

      • 議事録 / record of Proceedings
        議事録用のフォーマットです。開催情報や会議結果、AIといった会議用の記載欄が用意されています。

    2. 日英言語切替
      UIの表示言語と出力ファイルの記述を日本語と英語で切り替えます。トグルボタンの切替により変更可能です。（※一部フォーマットは英語未対応で、日本語の記述で出力されます。お手数ですが、適宜修正下さい。）
      images Jp En

    3. フリーページ
      ページ幅を可変にするオプションです。付加すると文書冒頭の定義に、:FreePage:という文言が加わります。解除したい場合は、定義を:!FreePage:とすると設定が無効になります。
      images V200 Option

    4. 右クリックショートカット追加ボタン
      Ver1.2.0で対応した、右クリックショートカットのインストールをGUI上で実行できます。
      ※もしGUI上でインストールに失敗した場合は、下記の手順で手動インストールください。

2.4. Ver 1.2.0

  • explorerの右クリックメニューから、ツールを起動できるように改良

    インストール手順

    1. GetADoc_GUI_1.2.0.zipを回答し、Ver 1.2.0のツールを配置する。

    2. ツールのフォルダでコマンドラインを起動する。
      Inst cmd

    3. コマンドラインで以下のコマンドを実行する。
      InstAdocUI.js.bat /Inst
      Inst cmd run

    4. 変更許可のダイアログが表示された場合は、許可を選択します。

    5. 処理の完了後、explorer上で右クリックを行い、以下のメニュー（赤枠）が追加されていれば、インストールは完了です。
      explorer image

    動作

    1. 雛形を作成したいPathをexplorerで開きます。

    2. explorer上で右クリックを行い、メニューから「GetADocUI」を開きます。

    3. ツールのフォルダ指定メニューに、「1.」で開いていたexplorerのPathが入力された状態で、ツールが起動します。

2.5. ver 1.1.1

  • コマンドラインで起動する際に、第一引数にPahtを指定すると、そのpathを「作成先のフォルダ」に設定した状態でツールを起動する昨日を追加

    入力例

    cmd arg

    起動時

    arg run

2.6. ver 1.1.0

  • 1つのPathを記憶できる機能を追加
    <strong>にチェックをいれると、記憶しているPathをテキストボックスに自動入力します。チェックをOFFにすると、前回指定したPathに切り替わります。

    Pathの登録方法

    1. <strong>にチェックを入れます。

    2. 未登録の場合、以下のメッセージが出力されます。
      savePath

    3. チェックをONにした状態で、任意のフォルダを設定し、ADocファイルを生成します。

    4. 生成処理が完了すると、チェックボックス横にPathの登録（更新）が完了したことを伝えるメッセージが表示されます。以上で、Pathの登録（更新）は完了です。次回以降、チェックボックスをON/OFFで、登録したPathを読み込められるようになります。

2.7. ver 1.0.0

images V200

  1. 出力先フォルダの指定メニュー
    ADocファイルの出力先を指定するメニューです以下の手順で設定できます。

    • ファイル参照ボタン
      <strong>ボタンをクリックすると、エクスプローラー形式のフォルダ選択メニューが表示されます。そこから任意のフォルダを選択することが出来ます。

    • エクスプローラーからのドラッグ＆ドロップ
      エクスプローラー上からGetADocGUI上にフォルダをドラッグし、マウスカーソルが「＋」のアイコンになっているタイミングでドロップすると、該当フォルダのフルPathがテキストボックスに自動入力されます。
      dragAndDrop

  2. ファイル名入力メニュー
    出力するADocファイルのファイル名を入力します。

  3. SCREENロゴの有無
    チェックボックスをONにすると、ドキュメント上部にSCREENのロゴと「Confidential」を記載したドキュメントを出力します。
    logo

  4. カスタムアイコン
    チェックボックスをONにすると、ドキュメント上の注釈アイコン（警告、注意など）をADocオリジナルのものから、マニュアル風に変更します。
    icon

  5. 分割ドキュメント
    分割ドキュメント形式のADoc雛形を作成します。（フルセット）
    bunkatsu

  6. 作成
    クリックすると、上記のメニューで指定した内容でADocファイルを出力します。完了すると以下のメッセージがUI上に表示されます。
    comp

以上