Skip to content

Latest commit

 

History

History
296 lines (190 loc) · 14.1 KB

document.adoc

File metadata and controls

296 lines (190 loc) · 14.1 KB

AsciiDoctor-PDF 日本語ドキュメントサンプル

変更履歴

更新日 更新者 確認日 確認者 変更内容

0.0

2019/11/9

山田太郎

2019/11/9

山田太郎

更新履歴のサンプル。
複数行に渡る更新履歴も書けます。

0.1

2019/11/9

山田太郎

新規作成

0.2

2020/6/2

山田太郎

画像の項を追加

1. はじめに

1.1. 目的

このドキュメントはAsciidoctor-pdfで日本語ドキュメントを書いた際にどのような出力になるかを確認するためのものです。テーマを上手に調整したらビジネス利用に耐えうるPDFドキュメントが生成できるのかどうかの検証も兼ねています。

Asciidocの全記法を網羅するのではなく、仕様書のような「硬い」ドキュメントでよく使われれるであろう記法にフォーカスしています。テーマも仕様書系のドキュメントを想定して調整しています。

2. AsciiDocの記法いろいろ

AsciiDocの記法がどのようなPDF出力になるかのサンプルです。ドキュメント作成で利用頻度が高そうな記法をピックアップしています。

2.1. 太字、斜体、等幅

太字は反映されますが、斜体はフォントが用意できなかったので反映されません。設定自体は有効なので、日本語の斜体フォントが手配できれば反映させられます。

bold, italic, bold and italic

太字のサンプル, 斜体のサンプル, 太字かつ斜体のサンプル

monospace, monospace and bold, monospace and italic, monospace and bold and italic

等幅のサンプル, 等幅かつ太字のサンプル, 等幅かつ斜体のサンプル, 等幅かつ太字かつ斜体のサンプル

2.2. いろいろな文字装飾

一通りの装飾が反映されます。

マーカー のサンプル, 大きい文字 のサンプル, 小さい文字 のサンプル

下線 のサンプル, 取り消し線 のサンプル

上付き文字のサンプル, 下付き文字のサンプル

“ダブルカーブクォート” のサンプル, ‘シングルカーブクォート’ のサンプル

2.3. リスト

リスト表示のサンプルです。番号なし、番号付きともに階層が深くなっても綺麗に表示できます。リスト内でも禁則処理は有効です。

  • 階層の深い番号なしリストの例

    • リストA-1

      • リストA-1-a

      • リストA-1-b

      • リストA-1-c

    • リストA-2

    • リストA-3

  • 階層の深い番号付きリストの例

    1. リストB-1

      1. リストB-1-a

      2. リストB-1-b

      3. リストB-1-c

    2. リストB-2

      1. リストB-2-i

      2. リストB-2-ii

      3. リストB-2-iii

    3. リストB-3

  • リストの中身が長文になる例

    • 日本国民は、正当に選挙された国会における代表者を通じて行動し、われらとわれらの子孫のために、諸国民との協和による成果と、わが国全土にわたつて自由のもたらす恵沢を確保し、政府の行為によつて再び戦争の惨禍が起ることのないやうにすることを決意し、ここに主権が国民に存することを宣言し、この憲法を確定する。

    • そもそも国政は、国民の厳粛な信託によるものてあつて、その権威は国民に由来し、その権力は国民の代表者がこれを行使し、その福利は国民がこれを享受する。これは人類普遍の原理であり、この憲法は、かかる原理に基くものである。われらは、これに反する一切の憲法、法令及び詔勅を排除する。

2.4. テーブル

テーブル記法の豊富さはAsciiDocの特長のひとつです。

2.4.1. CSV

No 名前 考案者 初出

1

AsciiDoc

Stuart Rackham

2002

2

DocBook

The Davenport Group, OASIS

1992

3

HTML

Tim Berners-Lee

1993

4

Markdown

John Gruber and Aaron Swartz

2004

5

TeX

Donald Knuth

1978

2.4.2. 縦積み

言語 パラダイム 型付け 登場時期

C

命令型

安全でない弱い静的型付け

1973

Java

命令型, オブジェクト指向, マルチプラットフォーム, ジェネリック

強い静的型付け

1994

JavaScript

命令型, オブジェクト指向, 関数型

強い動的型付け

1995

Swift

命令型, オブジェクト指向, 関数型、ジェネリック

強い静的型付け、型推論

2014

2.5. 画像

2.5.1. ブロック画像

ブロック画像のサンプルです。

ブロック画像のサンプル

2.5.2. インライン画像

インライン画像は36のようにして表示されます。

3. 長文サンプル

長めの文章のサンプルです。均等割り付けができないのと禁則処理が不完全なのがネックですが、可読性はさほど問題にならないのではないでしょうか。

3.1. 日本国憲法前文

日本国民は、正当に選挙された国会における代表者を通じて行動し、われらとわれらの子孫のために、諸国民との協和による成果と、わが国全土にわたつて自由のもたらす恵沢を確保し、政府の行為によつて再び戦争の惨禍が起ることのないやうにすることを決意し、ここに主権が国民に存することを宣言し、この憲法を確定する。そもそも国政は、国民の厳粛な信託によるものであつて、その権威は国民に由来し、その権力は国民の代表者がこれを行使し、その福利は国民がこれを享受する。これは人類普遍の原理であり、この憲法は、かかる原理に基くものである。われらは、これに反する一切の憲法、法令及び詔勅を排除する。

日本国民は、恒久の平和を念願し、人間相互の関係を支配する崇高な理想を深く自覚するのであつて、平和を愛する諸国民の公正と信義に信頼して、われらの安全と生存を保持しようと決意した。われらは、平和を維持し、専制と隷従、圧迫と偏狭を地上から永遠に除去しようと努めてゐる国際社会において、名誉ある地位を占めたいと思ふ。われらは、全世界の国民が、ひとしく恐怖と欠乏から免かれ、平和のうちに生存する権利を有することを確認する。

われらは、いづれの国家も、自国のことのみに専念して他国を無視してはならないのであつて、政治道徳の法則は、普遍的なものであり、この法則に従ふことは、自国の主権を維持し、他国と対等関係に立たうとする各国の責務であると信ずる。

日本国民は、国家の名誉にかけ、全力をあげてこの崇高な理想と目的を達成することを誓ふ。

3.2. 日本国憲法前文(英語版)

We, the Japanese People, acting through our duly elected representatives in the National Diet, determined that we shall secure for ourselves and our posterity the fruits of peaceful cooperation with all nations and the blessings of liberty throughout this land, and resolved that never again shall we be visited with the horrors of war through the action of government, do proclaim the sovereignty of the people’s will and do ordain and establish this Constitution, founded upon the universal principle that government is a sacred trust the authority for which is derived from the people, the powers of which are exercised by the representatives of the people, and the benefits of which are enjoyed by the people; and we reject and revoke all constitutions, ordinances, laws and rescripts in conflict herewith.

Desiring peace for all time and fully conscious of the high ideals controlling human relationship now stirring mankind, we have determined to rely for our security and survival upon the justice and good faith of the peace-loving peoples of the world. We desire to occupy an honored place in an international society designed and dedicated to the preservation of peace, and the banishment of tyranny and slavery, oppression and intolerance, for all time from the earth. We recognize and acknowledge that all peoples have the right to live in peace, free from fear and want.

We hold that no people is responsible to itself alone, but that laws of political morality are universal; and that obedience to such laws is incumbent upon all peoples who would sustain their own sovereignty and justify their sovereign relationship with other peoples.

To these high principles and purposes we, the Japanese People, pledge our national honor, determined will and full resources.

4. 日本語禁則処理サンプル

日本語の禁則についての基本ルールは3つあります。それぞれどのような結果になるかを確認するためのサンプルです。

4.1. 行頭禁則文字

行頭禁則は「特定の文字は行の頭にきてはいけない」というルールです。

4.1.1. 句読点

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです.禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルかつ、禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルかつ,禁則処理のサンプルです。

4.1.2. 拗促音

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルスペック。禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルをチャット。禁則処理のサンプルです。

4.1.3. 長音符

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルフレーズ。禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルフレーーズ。禁則処理のサンプルです。

4.1.4. 繰り返し

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルを諸々詰め込んだ禁則処理のサンプルです。

4.1.5. その他

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプリング・サンプル。禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです!!禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです??禁則処理のサンプルです。

4.2. 行末禁則文字

行末禁則は「特定の文字は行の末尾にきてはいけない」というルールです。

4.2.1. カッコ

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルは「禁則処理のサンプル」です。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルは【禁則処理のサンプル】です。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルは{禁則処理のサンプル}です。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルは(禁則処理のサンプル)です。

4.2.2. 記号

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルは〈禁則処理のサンプル〉です。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルは〝禁則処理のサンプル〟です。

4.3. 分割禁止文字

分離禁止は「特定の文字列は行をまたいで分離してはいけない」というルールです。

4.3.1. 二点リーダ・三点リーダ

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルと‥‥。禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルと……。禁則処理のサンプルです。

禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルです。禁則処理のサンプルと——。禁則処理のサンプルです。