質問するログイン新規登録

Q&A

2回答

139閲覧

AsciiDocで用語を一元管理するには

enoeno

総合スコア22

Markdown

Markdownは、文書の構造、修飾情報を記述するための軽量マークアップ言語です。

0グッド

0クリップ

投稿2025/10/28 13:23

0

0

実現したいこと

AsciiDocでチーム協業して設計書を書いているとき、同じものを指しているのに用語が人によって微妙に異なる場合があります。これを防ぐために用語定義用の.adocファイルを作ってそこに変数みたいなもので用語を定義して、各メンバーはこの変数を各ドキュメントで書けば用語のゆらぎは防げるんじゃないかと思い色々とAsciiDocの機能を調べましたが、これといった機能が探せませんでした。
何かいいアイディアはないでしょうか?

試したこと

用語.adocを用意して、設計書x.adocの中でタグ付きでincludeしてみる。

「用語.adoc」 tag::sys_def_tbl[] システム定義テーブル end::sys_def_tbl[]
「設計書A.adoc」 include::用語.adoc[tag=sys_def_tbl]
「設計書B.adoc」 include::用語.adoc[tag=sys_def_tbl]を作成する。
「設計書C.adoc」 * include::用語.adoc[tag=sys_def_tbl]

結果と疑問

「設計書A.adocのプレビュー」 システム定義テーブル
「設計書B.adocのプレビュー」 include::用語.adoc[tag=sys_def_tbl]を作成する。
「設計書C.adocのプレビュー」 ・ include::用語.adoc[tag=sys_def_tbl]

何か文章を続けるとダメなのか?
箇条書きの中では使えないのか?

目的は用語の一元管理なので他の方法でもかまいません。

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答2

0

属性(attributes)機能を活用するのはどうでしょうか?

① 用語集ファイルを作成する

asciidoc

1:AI: 人工知能 2:API: アプリケーションプログラミングインターフェイス 3:HTML: ハイパーテキストマークアップランゲージ 4:system_table: システム定義テーブル

② 各AsciiDocファイルで用語集をインクルードして利用する

asciidoc

1include::glossary.adoc[] 2 3本システムの設計には、{system_table}の理解が不可欠です。 4また、{AI}{API}の知識も要求されます。

参考:https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#attributes-and-substitutions

投稿2025/10/30 03:40

neko_the_shadow

総合スコア2416

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

すいません、自己解決なのかどうか自信がありませんが、以下にこう書かれてますね。

Includes | Asciidoctor Docs
https://docs.asciidoctor.org/asciidoc/latest/directives/include/#include-syntax

An include directive must be placed on a line by itself with the following syntax:

箇条書きを1行と見てくれないのは不満ですが。。。

投稿2025/10/30 03:25

enoeno

総合スコア22

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだベストアンサーが選ばれていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.29%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問