見出し画像

【Asciidoc】文書属性 ー 機能追加(其の壱) ー

今回から数回、機能を追加や環境を変更する文書属性を紹介してみよう。

まず、目次

:toc:                 // 既定値
:toc: left            // 左配置
:toc: right           // 右配置
:toc: preamble        // 前文後配置
:toc: macro           // マクロ文で挿入位置を指定
:toclevels: 3         // 目次表示階層
:toc-title: 目次       // 目次表題の変更

toc::[]                // 目次差込マクロ

基本、既定値で困ることはないと思う。書籍の構成上、「コピーライト」、「はじめに」や「序文」の後に「目次」をもってきたい場合、マクロ指定にすれば良いと思う。
階層の既定値は四階層です。最近のコンピュータ解説書籍は三階層が多いような気がします。(個人的な感想で統計を採ったわけではありません)
タイトルは規定値の「Table of Contents」でも良いですが「目次」とかにしておいた方が無難?。。。昔、「おしながき」という目次タイトルを見た記憶が在るが・・・。

書類概要ディスクリプション?自分はあまり利用しないのだけど、まあ、大事だと思う。

:description: 概要テキスト

// 二行に渡る場合は「+」で結合します。
:description: 概要テキスト + 
              二行目の概要テキスト

まあ、メタタグに変換されます。PDFとかだと意味はないかも。。。

<meta name=”description” content=”概要テキスト“>

しかし、「SEO」を意識した「meta」を構成するなら「noheader」属性を設定して「カスタムdocinfoファイル」を設定したほうが期待する結果を得られると思う。
それと本文中に「{description}」を挿入して再利用が可能です。

= 私の書類: 本の副題

:author_1: 紘稔
:email_1: <xxxx@email.com>
:author_2: 共同執筆者1
:email_2: <xxx1@email.com>
:revnumber: 0.1
:revdate: 2024-12-18
:doctype: book
:encoding: utf-8
:lang: ja
:toc: macro
:toclevels: 2
:toc-title: 目次
:description: 概要テキスト + 
              二行目の概要

== はじめに
この・・・文章は・・・{description}・・・です。

toc::[]

== 本章1
内容内容内容内容

=== 本節
内容内容内容内容

==== 本項
内容内容内容内容

== 本章2
内容内容内容内容

変換します。

この様な感じで表現されます。

さて、今回はこのあたりまで・・・・・・
次回は、「其の弐」かな。
…ではまた。

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


いいなと思ったら応援しよう!