【Asciidoc】ファイルを組み込むーincludeについてー

ファイルの組み込みインクルードは魅力的な機能です。
章や文節をバラバラに書いて一つの文章に組み上げることが出来るようになります。グループで執筆を進める場合に便利そうです。（「Git」を併用すれば尚良し。。。）

構文は

include::ファイル名[options]

自分の記事『「HELLO,WORLD」をAsciidocで書いてみる』（https://note.com/apt_hebe4580/n/nfc853364553a）のファイルを利用した例を一つ。

ファイルをインクルードした例

.「HELLO,WORLD」
====
include::helloworld.adoc[]

====

変換すると

組込例

「Hello,World」を例ブロックに組み込んでみました。

もう一つ、よく使われる例は「プログラムソース」の表示ですね。ファイルを一つ準備します。「helloworld.cs」としました。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace HelloWorld
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello, world!");
        }
    }
}

これをソースコードブロックに組み込みます。

[source,c#]
----
include::helloworld.cs[]

----

変換すると

ソース組込例

「全部を表示したいわけではない！」という方は

[source,c#]
----
include::helloworld.cs[lines=11..14]

----

範囲指定例

この様に行数を利用して範囲が指定できます。
これらはコンピュータ技術書の御用達で、一般的な例では無いのですが、利用する人は頻繁に利用することでしょう。
例えば・・・

XXX構文について

.helloworld.adoc
[source,asciidoc]
----
include::helloworld.adoc[]

----

.例題
====
include::helloworld.adoc[]

====

// 大事なことなので３回書いてみました！みたいな。

等と出来るのですから「Asciidoc」を「Asciidoc」で書いて解説する時は重宝します。（例文をしっかり用意しておけば狡い程、手を抜けます。「note」で利用できないのが残念です。）

さて、今回はこのあたりまで・・・・・・
次回は、もう少し組み込みの応用例を書いてみようと思います。
…ではまた。

当Noteは下記の「AsciiDoc Language Documentation」の文法に従っています。

AsciiDoc - AsciiDoc Language Documentation