asciidoctor 1.5.8 → 2.0.17

Sign up to get free protection for your applications and to get access to all the features.
Files changed (197) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +11 -0
  3. data/CHANGELOG.adoc +628 -45
  4. data/LICENSE +2 -1
  5. data/README-de.adoc +28 -38
  6. data/README-fr.adoc +30 -43
  7. data/README-jp.adoc +255 -201
  8. data/README-zh_CN.adoc +40 -44
  9. data/README.adoc +170 -143
  10. data/asciidoctor.gemspec +22 -34
  11. data/bin/asciidoctor +5 -4
  12. data/data/locale/attributes-ar.adoc +4 -3
  13. data/data/locale/attributes-be.adoc +23 -0
  14. data/data/locale/attributes-bg.adoc +4 -3
  15. data/data/locale/attributes-ca.adoc +6 -5
  16. data/data/locale/attributes-cs.adoc +4 -3
  17. data/data/locale/attributes-da.adoc +6 -5
  18. data/data/locale/attributes-de.adoc +6 -5
  19. data/data/locale/attributes-en.adoc +4 -4
  20. data/data/locale/attributes-es.adoc +6 -5
  21. data/data/locale/attributes-fa.adoc +4 -3
  22. data/data/locale/attributes-fi.adoc +4 -3
  23. data/data/locale/attributes-fr.adoc +8 -7
  24. data/data/locale/attributes-hu.adoc +4 -3
  25. data/data/locale/attributes-id.adoc +4 -3
  26. data/data/locale/attributes-it.adoc +6 -5
  27. data/data/locale/attributes-ja.adoc +4 -3
  28. data/data/locale/{attributes-kr.adoc → attributes-ko.adoc} +4 -3
  29. data/data/locale/attributes-nb.adoc +4 -3
  30. data/data/locale/attributes-nl.adoc +6 -5
  31. data/data/locale/attributes-nn.adoc +4 -3
  32. data/data/locale/attributes-pl.adoc +8 -7
  33. data/data/locale/attributes-pt.adoc +6 -5
  34. data/data/locale/attributes-pt_BR.adoc +6 -5
  35. data/data/locale/attributes-ro.adoc +4 -3
  36. data/data/locale/attributes-ru.adoc +6 -5
  37. data/data/locale/attributes-sr.adoc +4 -4
  38. data/data/locale/attributes-sr_Latn.adoc +4 -4
  39. data/data/locale/attributes-sv.adoc +4 -4
  40. data/data/locale/attributes-th.adoc +23 -0
  41. data/data/locale/attributes-tr.adoc +4 -3
  42. data/data/locale/attributes-uk.adoc +6 -5
  43. data/data/locale/attributes-vi.adoc +23 -0
  44. data/data/locale/attributes-zh_CN.adoc +4 -3
  45. data/data/locale/attributes-zh_TW.adoc +4 -3
  46. data/data/reference/syntax.adoc +296 -0
  47. data/data/stylesheets/asciidoctor-default.css +120 -114
  48. data/data/stylesheets/coderay-asciidoctor.css +15 -17
  49. data/lib/asciidoctor/abstract_block.rb +146 -140
  50. data/lib/asciidoctor/abstract_node.rb +152 -170
  51. data/lib/asciidoctor/attribute_list.rb +77 -89
  52. data/lib/asciidoctor/block.rb +29 -28
  53. data/lib/asciidoctor/callouts.rb +4 -2
  54. data/lib/asciidoctor/cli/invoker.rb +20 -24
  55. data/lib/asciidoctor/cli/options.rb +107 -96
  56. data/lib/asciidoctor/cli.rb +3 -2
  57. data/lib/asciidoctor/convert.rb +199 -0
  58. data/lib/asciidoctor/converter/composite.rb +40 -48
  59. data/lib/asciidoctor/converter/docbook5.rb +627 -644
  60. data/lib/asciidoctor/converter/html5.rb +1053 -951
  61. data/lib/asciidoctor/converter/manpage.rb +581 -532
  62. data/lib/asciidoctor/converter/template.rb +232 -271
  63. data/lib/asciidoctor/converter.rb +370 -185
  64. data/lib/asciidoctor/core_ext/float/truncate.rb +20 -0
  65. data/lib/asciidoctor/core_ext/hash/merge.rb +8 -0
  66. data/lib/asciidoctor/core_ext/match_data/names.rb +7 -0
  67. data/lib/asciidoctor/core_ext/nil_or_empty.rb +1 -0
  68. data/lib/asciidoctor/core_ext/regexp/is_match.rb +4 -2
  69. data/lib/asciidoctor/core_ext.rb +8 -17
  70. data/lib/asciidoctor/document.rb +503 -461
  71. data/lib/asciidoctor/extensions.rb +127 -174
  72. data/lib/asciidoctor/helpers.rb +184 -107
  73. data/lib/asciidoctor/inline.rb +9 -12
  74. data/lib/asciidoctor/list.rb +11 -29
  75. data/lib/asciidoctor/load.rb +119 -0
  76. data/lib/asciidoctor/logging.rb +22 -17
  77. data/lib/asciidoctor/parser.rb +673 -719
  78. data/lib/asciidoctor/path_resolver.rb +48 -33
  79. data/lib/asciidoctor/reader.rb +383 -338
  80. data/lib/asciidoctor/rouge_ext.rb +39 -0
  81. data/lib/asciidoctor/rx.rb +723 -0
  82. data/lib/asciidoctor/section.rb +17 -16
  83. data/lib/asciidoctor/stylesheets.rb +19 -37
  84. data/lib/asciidoctor/substitutors.rb +926 -1022
  85. data/lib/asciidoctor/syntax_highlighter/coderay.rb +88 -0
  86. data/lib/asciidoctor/syntax_highlighter/highlightjs.rb +34 -0
  87. data/lib/asciidoctor/syntax_highlighter/html_pipeline.rb +10 -0
  88. data/lib/asciidoctor/syntax_highlighter/prettify.rb +30 -0
  89. data/lib/asciidoctor/syntax_highlighter/pygments.rb +157 -0
  90. data/lib/asciidoctor/syntax_highlighter/rouge.rb +143 -0
  91. data/lib/asciidoctor/syntax_highlighter.rb +253 -0
  92. data/lib/asciidoctor/table.rb +152 -114
  93. data/lib/asciidoctor/timings.rb +7 -5
  94. data/lib/asciidoctor/version.rb +2 -1
  95. data/lib/asciidoctor/writer.rb +30 -0
  96. data/lib/asciidoctor.rb +266 -1340
  97. data/man/asciidoctor.1 +49 -47
  98. data/man/asciidoctor.adoc +54 -45
  99. metadata +50 -245
  100. data/CONTRIBUTING.adoc +0 -185
  101. data/Gemfile +0 -60
  102. data/Rakefile +0 -129
  103. data/bin/asciidoctor-safe +0 -15
  104. data/features/open_block.feature +0 -92
  105. data/features/pass_block.feature +0 -66
  106. data/features/step_definitions.rb +0 -49
  107. data/features/text_formatting.feature +0 -57
  108. data/features/xref.feature +0 -1039
  109. data/lib/asciidoctor/converter/base.rb +0 -59
  110. data/lib/asciidoctor/converter/docbook45.rb +0 -93
  111. data/lib/asciidoctor/converter/factory.rb +0 -226
  112. data/lib/asciidoctor/core_ext/1.8.7/base64/strict_encode64.rb +0 -6
  113. data/lib/asciidoctor/core_ext/1.8.7/concurrent/hash.rb +0 -5
  114. data/lib/asciidoctor/core_ext/1.8.7/hash/key.rb +0 -4
  115. data/lib/asciidoctor/core_ext/1.8.7/io/binread.rb +0 -6
  116. data/lib/asciidoctor/core_ext/1.8.7/io/write.rb +0 -5
  117. data/lib/asciidoctor/core_ext/1.8.7/string/chr.rb +0 -6
  118. data/lib/asciidoctor/core_ext/1.8.7/string/limit_bytesize.rb +0 -29
  119. data/lib/asciidoctor/core_ext/1.8.7/symbol/empty.rb +0 -6
  120. data/lib/asciidoctor/core_ext/1.8.7/symbol/length.rb +0 -6
  121. data/lib/asciidoctor/core_ext/string/limit_bytesize.rb +0 -10
  122. data/test/api_test.rb +0 -1240
  123. data/test/attribute_list_test.rb +0 -242
  124. data/test/attributes_test.rb +0 -1623
  125. data/test/blocks_test.rb +0 -3870
  126. data/test/converter_test.rb +0 -470
  127. data/test/document_test.rb +0 -1853
  128. data/test/extensions_test.rb +0 -1560
  129. data/test/fixtures/asciidoc_index.txt +0 -521
  130. data/test/fixtures/basic-docinfo-footer.html +0 -6
  131. data/test/fixtures/basic-docinfo-footer.xml +0 -8
  132. data/test/fixtures/basic-docinfo.html +0 -1
  133. data/test/fixtures/basic-docinfo.xml +0 -4
  134. data/test/fixtures/basic.asciidoc +0 -5
  135. data/test/fixtures/chapter-a.adoc +0 -3
  136. data/test/fixtures/child-include.adoc +0 -5
  137. data/test/fixtures/circle.svg +0 -9
  138. data/test/fixtures/custom-backends/erb/html5/block_paragraph.html.erb +0 -6
  139. data/test/fixtures/custom-backends/haml/docbook45/block_paragraph.xml.haml +0 -6
  140. data/test/fixtures/custom-backends/haml/html5/block_paragraph.html.haml +0 -3
  141. data/test/fixtures/custom-backends/haml/html5/block_sidebar.html.haml +0 -5
  142. data/test/fixtures/custom-backends/haml/html5-tweaks/block_paragraph.html.haml +0 -1
  143. data/test/fixtures/custom-backends/slim/docbook45/block_paragraph.xml.slim +0 -6
  144. data/test/fixtures/custom-backends/slim/html5/block_paragraph.html.slim +0 -3
  145. data/test/fixtures/custom-backends/slim/html5/block_sidebar.html.slim +0 -5
  146. data/test/fixtures/custom-docinfodir/basic-docinfo.html +0 -1
  147. data/test/fixtures/custom-docinfodir/docinfo.html +0 -1
  148. data/test/fixtures/docinfo-footer.html +0 -1
  149. data/test/fixtures/docinfo-footer.xml +0 -9
  150. data/test/fixtures/docinfo.html +0 -1
  151. data/test/fixtures/docinfo.xml +0 -3
  152. data/test/fixtures/doctime-localtime.adoc +0 -2
  153. data/test/fixtures/dot.gif +0 -0
  154. data/test/fixtures/encoding.asciidoc +0 -13
  155. data/test/fixtures/file-with-missing-include.adoc +0 -1
  156. data/test/fixtures/grandchild-include.adoc +0 -3
  157. data/test/fixtures/hello-asciidoctor.pdf +0 -69
  158. data/test/fixtures/include-file.asciidoc +0 -24
  159. data/test/fixtures/include-file.jsx +0 -8
  160. data/test/fixtures/include-file.ml +0 -3
  161. data/test/fixtures/include-file.xml +0 -5
  162. data/test/fixtures/lists.adoc +0 -96
  163. data/test/fixtures/master.adoc +0 -5
  164. data/test/fixtures/mismatched-end-tag.adoc +0 -7
  165. data/test/fixtures/other-chapters.adoc +0 -11
  166. data/test/fixtures/outer-include.adoc +0 -5
  167. data/test/fixtures/parent-include-restricted.adoc +0 -5
  168. data/test/fixtures/parent-include.adoc +0 -5
  169. data/test/fixtures/sample.asciidoc +0 -30
  170. data/test/fixtures/section-a.adoc +0 -4
  171. data/test/fixtures/stylesheets/custom.css +0 -3
  172. data/test/fixtures/subdir/index.adoc +0 -3
  173. data/test/fixtures/subdir/inner-include.adoc +0 -3
  174. data/test/fixtures/subdir/middle-include.adoc +0 -5
  175. data/test/fixtures/subs-docinfo.html +0 -2
  176. data/test/fixtures/subs.adoc +0 -6
  177. data/test/fixtures/tagged-class-enclosed.rb +0 -25
  178. data/test/fixtures/tagged-class.rb +0 -23
  179. data/test/fixtures/tip.gif +0 -0
  180. data/test/fixtures/unclosed-tag.adoc +0 -3
  181. data/test/fixtures/unexpected-end-tag.adoc +0 -4
  182. data/test/invoker_test.rb +0 -745
  183. data/test/links_test.rb +0 -855
  184. data/test/lists_test.rb +0 -5151
  185. data/test/logger_test.rb +0 -211
  186. data/test/manpage_test.rb +0 -660
  187. data/test/options_test.rb +0 -262
  188. data/test/paragraphs_test.rb +0 -562
  189. data/test/parser_test.rb +0 -742
  190. data/test/paths_test.rb +0 -395
  191. data/test/preamble_test.rb +0 -173
  192. data/test/reader_test.rb +0 -2161
  193. data/test/sections_test.rb +0 -3575
  194. data/test/substitutions_test.rb +0 -2066
  195. data/test/tables_test.rb +0 -2036
  196. data/test/test_helper.rb +0 -447
  197. data/test/text_test.rb +0 -309
data/README-jp.adoc CHANGED
@@ -1,8 +1,7 @@
1
1
  = Asciidoctor
2
- Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>; Ryan Waldron <https://github.com/erebor[@erebor]>
3
- v1.5.8, 2018-10-28
2
+ Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
3
+ v2.0.17, 2022-01-05
4
4
  // settings:
5
- :page-layout: base
6
5
  :idprefix:
7
6
  :idseparator: -
8
7
  :source-language: ruby
@@ -10,7 +9,6 @@ v1.5.8, 2018-10-28
10
9
  ifndef::env-github[:icons: font]
11
10
  ifdef::env-github[]
12
11
  :status:
13
- :outfilesuffix: .adoc
14
12
  :caution-caption: :fire:
15
13
  :important-caption: :exclamation:
16
14
  :note-caption: :paperclip:
@@ -18,13 +16,17 @@ ifdef::env-github[]
18
16
  :warning-caption: :warning:
19
17
  endif::[]
20
18
  // Variables:
21
- :release-version: 1.5.8
19
+ :release-version: 2.0.17
22
20
  // URIs:
23
21
  :uri-org: https://github.com/asciidoctor
24
22
  :uri-repo: {uri-org}/asciidoctor
25
23
  :uri-asciidoctorj: {uri-org}/asciidoctorj
26
24
  :uri-asciidoctorjs: {uri-org}/asciidoctor.js
27
- :uri-project: http://asciidoctor.org
25
+ :uri-gradle-plugin: {uri-org}/asciidoctor-gradle-plugin
26
+ :uri-maven-plugin: {uri-org}/asciidoctor-maven-plugin
27
+ :uri-asciidoclet: {uri-org}/asciidoclet
28
+ :uri-project: https://asciidoctor.org
29
+ :uri-gem: https://rubygems.org/gems/asciidoctor
28
30
  ifdef::env-site[:uri-project: link:]
29
31
  :uri-docs: {uri-project}/docs
30
32
  :uri-news: {uri-project}/news
@@ -33,153 +35,229 @@ ifdef::env-site[:uri-project: link:]
33
35
  :uri-contributors: {uri-repo}/graphs/contributors
34
36
  :uri-rel-file-base: link:
35
37
  :uri-rel-tree-base: link:
36
- ifdef::env-site[]
37
- :uri-rel-file-base: {uri-repo}/blob/master/
38
- :uri-rel-tree-base: {uri-repo}/tree/master/
38
+ ifdef::env-site,env-yard[]
39
+ :uri-rel-file-base: {uri-repo}/blob/HEAD/
40
+ :uri-rel-tree-base: {uri-repo}/tree/HEAD/
39
41
  endif::[]
40
42
  :uri-changelog: {uri-rel-file-base}CHANGELOG.adoc
41
43
  :uri-contribute: {uri-rel-file-base}CONTRIBUTING.adoc
42
44
  :uri-license: {uri-rel-file-base}LICENSE
43
45
  :uri-tests: {uri-rel-tree-base}test
44
- :uri-discuss: http://discuss.asciidoctor.org
45
- :uri-irc: irc://irc.freenode.org/#asciidoctor
46
+ :uri-discuss: https://discuss.asciidoctor.org
47
+ :uri-chat: https://asciidoctor.zulipchat.com
46
48
  :uri-rubygem: https://rubygems.org/gems/asciidoctor
47
49
  :uri-what-is-asciidoc: {uri-docs}/what-is-asciidoc
48
50
  :uri-user-manual: {uri-docs}/user-manual
49
51
  :uri-install-docker: https://github.com/asciidoctor/docker-asciidoctor
50
52
  //:uri-install-doc: {uri-docs}/install-toolchain
51
- :uri-install-osx-doc: {uri-docs}/install-asciidoctor-macosx
52
- :uri-render-doc: {uri-docs}/render-documents
53
+ :uri-install-macos-doc: {uri-docs}/install-asciidoctor-macos
54
+ :uri-convert-doc: {uri-docs}/convert-documents
53
55
  :uri-themes-doc: {uri-docs}/produce-custom-themes-using-asciidoctor-stylesheet-factory
54
56
  :uri-gitscm-repo: https://github.com/git/git-scm.com
55
- :uri-prototype: {uri-gitscm-repo}/commits/master/lib/asciidoc.rb
56
57
  :uri-freesoftware: https://www.gnu.org/philosophy/free-sw.html
57
- :uri-foundation: http://foundation.zurb.com
58
+ :uri-foundation: https://foundation.zurb.com
59
+ :uri-opal: https://opalrb.com
58
60
  :uri-tilt: https://github.com/rtomayko/tilt
59
- :uri-ruby: https://ruby-lang.org
61
+ :uri-ruby: https://www.ruby-lang.org
60
62
  // images:
61
- :image-uri-screenshot: https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/screenshot.png
62
-
63
- {uri-project}/[Asciidoctor] _高速な_ テキストプロセッサで {uri-what-is-asciidoc}[AsciiDoc] HTML5, DocBook 5(4.5)や他のフォーマットに変換するツールチェインを配布しています.
64
- AsciidoctorはRubyで書かれており, RubyGemとしてパッケージされ, {uri-rubygem}[RubyGems.org] で配布されています.
65
- gemはいくつかのLinuxディストリビューション, Fedora, Debian, Ubuntuにも含まれています.
66
- Asciidoctorはオープンソース {uri-repo}[hosted on Github] で {uri-license}[the MIT licence]のもとに配布されます.
67
-
68
- ifndef::env-site[]
69
- Translations of this document are available in the following languages:
70
-
71
- * {uri-rel-file-base}README-zh_CN.adoc[汉语]
72
- * {uri-rel-file-base}README.adoc[English]
73
- * {uri-rel-file-base}README-fr.adoc[Français]
63
+ :image-uri-screenshot: https://cdn.jsdelivr.net/gh/asciidoctor/asciidoctor/screenshot.png
64
+
65
+ {uri-project}[Asciidoctor]は, {uri-what-is-asciidoc}[AsciiDoc] で書かれたコンテンツをHTML5, DocBook, PDFなどのフォーマットに変換する, _高速で_ {uri-license}[オープンソース] のテキストプロセッサおよびパブリッシングツールチェインです.
66
+ AsciidoctorはRubyで書かれており, すべての主要オペレーティングシステムで動作します.
67
+ Asciidoctorプロジェクトは {uri-repo}[GitHubにホスティング] されています.
68
+
69
+ インストールをシンプルにするため, AsciidoctorはRubyGem(gem)パッケージとして, {uri-rubygem}[RubyGems.org] で配布されています.
70
+ さらに, Asciidoctorは主要なLinuxディストリビューション用およびmacOS用パッケージとしても配布されています.
71
+ AsciidoctorはRubyで動作するだけでなく, {uri-asciidoctorj}[AsciidoctorJ]としてJVM上でも動作します. また, {uri-asciidoctorjs}[Asciidoctor.js]としてどのようなJavaScript環境(ブラウザを含む)でも実行できます.
72
+
73
+ ifndef::env-site,env-yard[]
74
+ このドキュメントには以下の言語版が存在します: +
75
+ {uri-rel-file-base}README.adoc[English]
76
+ |
77
+ {uri-rel-file-base}README-zh_CN.adoc[汉语]
78
+ |
79
+ {uri-rel-file-base}README-de.adoc[Deutsch]
80
+ |
81
+ {uri-rel-file-base}README-fr.adoc[Français]
74
82
  endif::[]
75
83
 
76
- .Key documentation
84
+ .主なドキュメント
77
85
  [.compact]
78
86
  * {uri-docs}/what-is-asciidoc[What is AsciiDoc?]
79
87
  * {uri-docs}/asciidoc-writers-guide[AsciiDoc Writer's Guide]
80
- * {uri-docs}/asciidoc-syntax-quick-reference[AsciiDoc Syntax Reference]
81
88
  * {uri-docs}/user-manual[Asciidoctor User Manual]
82
-
83
- .Rubyの行く先, Asciidoctorの追うところ
84
- ****
85
- AsciidoctorはJRubyを用いてJVM上でも実行できます.
86
- Javaや他のJVM言語からAsciidoctor APIを直接呼び出すには, {uri-asciidoctorj}[AsciidoctorJ] を使ってください.
87
- AsciidoctorJに基づいた, AsciidoctorプロセッサをApache Maven, GradleやJavadocに統合するプラグインがあります.
88
-
89
- AsciidoctorはJavaScriptでも実行可能です.
90
- {uri-asciidoctorjs}[Asciidoctor.js], WebブラウザやNode.jsのようなJavaScript環境で動くAsciidoctorの完全機能版, を生成するために, RubyのソースをJavaScriptにトランスパイルするのに http://opalrb.org[Opal]を使います.
91
- Asciidoctor.jsはChrome, Atom, Brackets や他のウェブベースのツールの拡張機能としてAsciiDocのプレビューのために使われます.
92
- ****
89
+ * {uri-docs}/asciidoc-syntax-quick-reference[AsciiDoc Syntax Reference]
93
90
 
94
91
  ifdef::status[]
95
- .*Project health*
96
- image:https://img.shields.io/travis/asciidoctor/asciidoctor/master.svg[Build Status (Travis CI), link=https://travis-ci.org/asciidoctor/asciidoctor]
97
- image:https://ci.appveyor.com/api/projects/status/ifplu67oxvgn6ceq/branch/master?svg=true&amp;passingText=green%20bar&amp;failingText=%23fail&amp;pendingText=building%2E%2E%2E[Build Status (AppVeyor), link=https://ci.appveyor.com/project/asciidoctor/asciidoctor]
98
- //image:https://img.shields.io/coveralls/asciidoctor/asciidoctor/master.svg[Coverage Status, link=https://coveralls.io/r/asciidoctor/asciidoctor]
99
- image:https://codeclimate.com/github/asciidoctor/asciidoctor/badges/gpa.svg[Code Climate, link="https://codeclimate.com/github/asciidoctor/asciidoctor"]
100
- image:https://inch-ci.org/github/asciidoctor/asciidoctor.svg?branch=master[Inline docs, link="https://inch-ci.org/github/asciidoctor/asciidoctor"]
92
+ image:https://img.shields.io/gem/v/asciidoctor.svg[Latest Release, link={uri-gem}]
93
+ image:https://img.shields.io/badge/rubydoc.info-{release-version}-blue.svg[library (API) docs,link=https://www.rubydoc.info/gems/asciidoctor/{release-version}]
94
+ image:https://github.com/asciidoctor/asciidoctor/workflows/CI/badge.svg[Build Status (GitHub Actions),link={uri-repo}/actions]
95
+ image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[Project Chat,link={uri-chat}]
101
96
  endif::[]
102
97
 
103
- == The Big Picture
98
+ == スポンサー
99
+
100
+ {uri-project}/supporters[スポンサー] のみなさまが, このプロジェクトをサポートし, より良いテクニカルドキュメンテーションの実現にコミットメントをしてくださっていることに感謝します.
101
+ スポンサーのみなさま, ありがとうございます!
102
+ みなさまの多くのサポートなくしてAsciidoctorは実現不可能です.
104
103
 
105
- Asciidoctorは下図の左側のパネルに示されるように, 平文で書かれた内容を読み, 右のパネルに描かれるようにHTML5に変換します.
106
- Asciidoctorは枠にとらわれない快適なエクスペリエンスのためにデフォルトスタイルシートをHTML5ドキュメントに適用します.
104
+ https://opencollective.com/asciidoctor[OpenCollective] を通じてスポンサーになることにより, このプロジェクトを支援することができます.
107
105
 
108
- image::{image-uri-screenshot}[Preview of AsciiDoc source and corresponding rendered HTML]
106
+ == 全体像
109
107
 
110
- == AsciiDoc Processing
111
- AsciidoctorはAsciiDoc文法で書かれたテキストを読み込み解釈し, それからHTML5, DocBook5(4.5)やman(ual)を出力するために内蔵コンバータセットにパースツリーを渡します.
112
- 生成された出力をカスタマイズ, あるいは追加のフォーマットをつくるためにあなた自身のコンバータを使うことや {uri-tilt}[Tilt]-supported テンプレートを読み込むオプションがあります.
108
+ Asciidoctorは, 下図左側のようなプレーンテキストを読み込んで, 右側のようなHTML5に変換します.
109
+ 特別な設定をしなくてもきれいな表示が得られるよう, HTML5の出力にはデフォルトのスタイルシートが適用されます.
113
110
 
114
- NOTE: AsciidoctorはオリジナルのAsciiDoc Pythonプロセッサ(`asciidoc.py`)の完全互換です.
115
- Asciidoctorテストスイートは {uri-tests}[> 1,600 tests] をAsciiDoc文法との互換性を保証するために有しています.
111
+ image::{image-uri-screenshot}[AsciiDocソースとレンダリングされたHTMLのプレビュー]
116
112
 
117
- クラシックなAsciiDoc文法に加えて, Asciidoctorは追加のマークアップとフォントベースのicons(例えば, `+icon:fire[]+`)などのフォーマッティングオプションとUIエレメント(`+button:[Save]+`)を 受け付けます.
118
- AsciidoctorはHTML5出力をスタイルするため, モダンで, {uri-foundation}[Foundation] に基づいたレスポンシブテーマをも提供します.
113
+ == AsciiDocの処理
119
114
 
120
- == Requirements
115
+ Asciidoctorは, AsciiDoc文法で書かれたテキストを読み込んでパースします. 次に内蔵コンバータにパースツリーを渡します. これによりHTML5, DocBook 5やman(マニュアルmanページ)が出力されます.
116
+ 出力をカスタマイズしたりフォーマットを追加したりしたいときは, ユーザ独自のコンバータや {uri-tilt}[Tilt] 対応テンプレートを使用することができます.
121
117
 
122
- AsciidoctorはLinux, OS X (Mac)とWindowsで動き, 下記の {uri-ruby}[Ruby]実装の一つを必要とします.
118
+ AsciidoctorはオリジナルのAsciiDoc Pythonプロセッサ(`asciidoc.py`)に完全互換です.
119
+ Asciidoctorのテストスイートには, AsciiDoc文法との互換性を保証するために {uri-tests}[2350個を超えるテスト] が入っています.
123
120
 
124
- * MRI (Ruby 1.8.7, 1.9.3, 2.0, 2.1, 2.2 & 2.3)
125
- * JRuby (1.7 in Ruby 1.8 and 1.9 modes, 9000)
126
- * Rubinius 2.2.x
121
+ Asciidoctorでは, AsciiDocの従来の文法のほかに, Asciidoctorで追加されたマークアップとフォーマッティングオプションが使用できます. フォントベースのアイコン (例えば, `+icon:fire[]+`) やUIエレメント(`+button:[Save]+`)がそれにあたります.
122
+ またAsciidoctorは, HTML5出力時のスタイルとして {uri-foundation}[Foundation] に基づいたモダンでレスポンシブなテーマも提供します.
123
+
124
+ == RubyのあるところAsciidoctorも動く
125
+
126
+ AsciidoctorはJRubyを用いてJVM上でも実行できます.
127
+ Javaや他のJVM言語からAsciidoctor APIを直接呼び出すには, {uri-asciidoctorj}[AsciidoctorJ] を使ってください.
128
+ AsciidoctorJを使ったAsciiDocの処理をビルドに直接組み込むビルドツール用プラグインとして, {uri-maven-plugin}[Apache Maven用], {uri-gradle-plugin}[Gradle用], および {uri-asciidoclet}[Javadoc用] が存在します.
129
+
130
+ AsciidoctorはJavaScriptでも実行可能です.
131
+ Rubyで書かれたソースを {uri-opal}[Opal] を使ってJavaScriptにトランスパイルすることで {uri-asciidoctorjs}[Asciidoctor.js] が作成されています.
132
+ Asciidoctor.jsはどんなJavaScript環境(WebブラウザやNode.jsを含む)でも動作する, JavaScript版の完全なAsciidoctorです.
133
+ Chrome, Atom, Bracketsやその他のウェブベースのツールで, AsciiDocをプレビューするための拡張機能にAsciidoctor.jsが使われています.
134
+
135
+ == 必要条件
136
+
137
+ AsciidoctorはLinux, macOS, およびWindowsで動作し, 下記の {uri-ruby}[Ruby]実装の一つを必要とします.
138
+
139
+ * CRuby (aka MRI) 2.3 - 2.6
140
+ * JRuby 9.1 - 9.2
141
+ * TruffleRuby (GraalVM)
127
142
  * Opal (JavaScript)
128
143
 
129
144
  [CAUTION]
130
145
  ====
131
- もし非英語環境のWindowsを使っているなら, Asciidoctorを起動した時に `Encoding::UndefinedConversionError` に遭遇するでしょう.
132
- これを解決するには使っているコンソールの有効なコードページをUTF-8:
146
+ もし非英語環境のWindowsを使っているなら, Asciidoctorを起動した時に `Encoding::UndefinedConversionError` に遭遇するかもしれません.
147
+ これを解決するには, 以下のコマンドにより, 使っているコンソールの有効なコードページをUTF-8に変更することを推奨します:
133
148
 
134
149
  chcp 65001
135
150
 
136
- に変更することを推奨します.
137
151
  一度この変更をすると, Unicode関連の頭痛の種は消えるでしょう.
138
152
  もしEclipseのようなIDEを使っているなら, 同様にエンコーディングをUTF-8にするのを忘れないでください.
139
- AsciidoctorはUTF-8が使われているところで最高の働きを見せます.
153
+ AsciidoctorはUTF-8の環境において最も良好に動作します.
140
154
  ====
141
155
 
142
- == Installation
156
+ == インストール
143
157
 
144
- Asciidoctor (a) `gem install` コマンド, (b) Bundler あるいは (c) 有名Linuxディストリビューションのパッケージマネージャ を用いてインストールされます.
158
+ Asciidoctorは, (a) 主なLinuxディストリビューションのパッケージマネージャ, (b) macOSのHomebrew, (c) `gem install` コマンド(Windowsユーザに推奨), (d) Asciidoctor Dockerイメージ, あるいは(e) Bundlerを用いてインストールできます.
145
159
 
146
- TIP: Linuxパッケージマネージャを用いてインストールすることの利点は, もしRubyやRubyGemsライブラリがまだインストールされていなかったら, それらを処理してくれることです.
147
- 欠点はgemのリリース直後にはすぐには有効にならないことです.
148
- もし最新バージョンを使いたければ, 必ず `gem` コマンドを使いましょう.
160
+ Linuxパッケージマネージャを用いてインストールする利点は, もしRubyやRubyGemsライブラリがまだインストールされていなかったら, それらをインストールしてくれることです.
149
161
 
150
- === (a) gem install
162
+ === (a) Linuxのパッケージマネージャ
151
163
 
152
- ターミナルを開き, 入力しましょう (先頭の`$`は除く):
164
+ パッケージマネージャによってインストールされるAsciidoctorは最新バージョンではないかもしれません.
165
+ ディストリビューションの各リリースにおいてどのバージョンのAsciidoctorがパッケージされているかを確認するには, パッケージリポジトリを参照してください.
153
166
 
154
- $ gem install asciidoctor
167
+ * https://pkgs.alpinelinux.org/packages?name=asciidoctor[Alpine Linux (asciidoctor)]
168
+ * https://www.archlinux.org/packages/?name=asciidoctor[Arch Linux (asciidoctor)]
169
+ * https://packages.debian.org/sid/asciidoctor[Debian (asciidoctor)]
170
+ * https://apps.fedoraproject.org/packages/rubygem-asciidoctor[Fedora (asciidoctor)]
171
+ * https://software.opensuse.org/package/rubygem-asciidoctor[OpenSUSE (rubygem-asciidoctor)]
172
+ * https://packages.ubuntu.com/search?keywords=asciidoctor[Ubuntu (asciidoctor)]
155
173
 
156
- もし, 先行リリースバージョン(例えばリリース候補版)をインストールしたければ
174
+ パッケージマネージャによってインストールされるバージョンよりも新しいAsciidoctorを使用したい場合は, <<gem-install,gemのインストール方法>> を参照してください.
157
175
 
158
- $ gem install asciidoctor --pre
176
+ ==== apk (Alpine Linux)
159
177
 
160
- .アップグレード
161
- [TIP]
162
- ====
163
- もしAsciidoctorの以前のバージョンがインストール済みであれば, 以下によってアップデートできます:
178
+ Alpine Linuxにgemをインストールするには, ターミナルを開き, 以下を入力してください:
164
179
 
165
- $ gem update asciidoctor
180
+ $ sudo apk add asciidoctor
166
181
 
167
- もし gem update の代わりに `gem install` を使ってgemを新バージョンにした場合, 複数バージョンがインストールされるでしょう.
168
- そのときは, 以下のgemコマンドで古いバージョンを削除しましょう:
182
+ ==== pacman (Arch Linux)
169
183
 
170
- $ gem cleanup asciidoctor
171
- ====
184
+ Archベースのディストリビューションにgemをインストールするには, ターミナルを開き, 以下を入力してください:
185
+
186
+ $ sudo pacman -S asciidoctor
187
+
188
+ ==== APT
189
+
190
+ Debian, またはUbuntuなどDebianベースのディストリビューションでは, APTを使ってAsciidoctorをインストールしてください.
191
+ Asciidoctorパッケージをインストールするには, ターミナルを開き, 以下を入力してください:
192
+
193
+ $ sudo apt-get install -y asciidoctor
194
+
195
+ ==== DNF
196
+
197
+ Fedora, CentOS, RHELなどRPMベースのLinuxディストリビューションでは, DNFパッケージマネージャを使ってAsciidoctorをインストールしてください.
198
+ Asciidoctorパッケージをインストールするには, ターミナルを開き, 以下を入力してください:
199
+
200
+ $ sudo dnf install -y asciidoctor
201
+
202
+ === (b) Homebrew (macOS)
203
+
204
+ macOSでは, パッケージマネージャHomebrewを使用してAsciidoctorをインストールすることができます.
205
+ Homebrewをお持ちでない場合は, まず https://brew.sh/[brew.sh] の説明に従ってHomebrewをインストールしてください.
206
+ Homebrewをインストールできたら, `asciidoctor` gemをインストールすることができます.
207
+ ターミナルを開き, 以下を入力してください:
208
+
209
+ $ brew install asciidoctor
210
+
211
+ Homebrewにより, システムレベルのgemとは別の独立したprefixのパスに `asciidoctor` gemがインストールされます.
212
+
213
+ === (c) Windows
172
214
 
173
- === (b) Bundler
215
+ WindowsでAsciidoctorを使う場合は, 簡単な方法が2つあります.
174
216
 
175
- . プロジェクトフォルダーのルート(かカレントディレクトリ)にGemfileを作成
217
+ ==== Chocolatey
218
+
219
+ すでにお使いのマシンで https://chocolatey.org[chocolatey] を使用しているなら, 以下の方法を使用することができます:
220
+
221
+ [source]
222
+ ----
223
+ choco install ruby
224
+ ----
225
+
226
+ そのあとは <<gem-install,gemのインストール方法>> に従ってください.
227
+
228
+ ==== Rubyinstaller
229
+
230
+ https://rubyinstaller.org/downloads/[Rubyinstaller] を使用したい場合は, お使いのWindowsのバージョンに適したRubyinstallerをダウンロードしてRubyをインストールしたあと, <<gem-install,gemのインストール方法>> に従ってください.
231
+
232
+ [#gem-install]
233
+ === (d) gem install
234
+
235
+ Asciidoctorを `gem install` を使ってインストールするのであれば, その前に https://rvm.io[RVM] を使ってhomeディレクトリ(つまりユーザ領域)にRubyをインストールしておくべきです.
236
+ そうすれば, `gem` コマンドを使用して安全にAsciidoctor gemのインストールやアップデートができます.
237
+ RVMを使用すると, システムから隔離された場所にgemがインストールされます.
238
+
239
+ ターミナルを開き, 以下のように入力してください:
240
+
241
+ $ gem install asciidoctor
242
+
243
+ もし, 先行リリースバージョン(例えばリリース候補版)をインストールしたければ以下のようにします.
244
+
245
+ $ gem install asciidoctor --pre
246
+
247
+ === (e) Docker
248
+
249
+ {uri-install-docker}[Installing Asciidoctor using Docker]を参照してください.
250
+
251
+ === (f) Bundler
252
+
253
+ . プロジェクトのルートフォルダ(またはカレントディレクトリ)にGemfileを作成
176
254
  . `asciidoctor` gemをGemfileに以下のように追加:
177
255
  +
178
256
  [source,subs=attributes+]
179
257
  ----
180
258
  source 'https://rubygems.org'
181
259
  gem 'asciidoctor'
182
- # or specify the version explicitly
260
+ # または明示的にバージョンを指定
183
261
  # gem 'asciidoctor', '{release-version}'
184
262
  ----
185
263
 
@@ -189,111 +267,89 @@ gem 'asciidoctor'
189
267
  $ bundle
190
268
 
191
269
  gemをアップグレードするには, Gemfileで新バージョンを指定し, `bundle` を再び実行してください.
192
- `bundle update` は他のgemもアップデートするため推奨されて *いない* ので, 思わぬ結果になるかも知れません.
270
+ `bundle update` を(gemを指定せずに)行うことは推奨 *されません* . 他のgemもアップデートされて思わぬ結果になるかもしれないためです.
193
271
 
194
- === (c) Linux package managers
272
+ == アップグレード
195
273
 
196
- ==== DNF (Fedora 21 or greater)
274
+ オペレーティングシステムのパッケージマネージャでAsciidoctorをインストールしたのであれば, おそらくパッケージは自動的にアップデートされるように設定されています. その場合は, gemを手動でアップデートする必要はありません.
197
275
 
198
- dnfを使いFedora21かそれ以上にインストールするには, ターミナルを開き, 以下を入力してください:
276
+ === apk (Alpine Linux)
199
277
 
200
- $ sudo dnf install -y asciidoctor
201
-
202
- gemをアップグレードするには:
203
-
204
- $ sudo dnf update -y asciidoctor
205
-
206
- TIP: お使いのシステムは自動的にrpmパッケージをアップデートするよう設定されているかも知れません.その場合, gemのアップデートのためにあなたがすべきことはありません.
278
+ gemをアップグレードするには, 以下を使用してください:
207
279
 
208
- ==== apt-get (Debian, Ubuntu, Mint)
209
-
210
- Debian, UbuntuまたはMintにインストールするには, ターミナルを開き, 以下を入力してください:
280
+ $ sudo apk add -u asciidoctor
211
281
 
212
- $ sudo apt-get install -y asciidoctor
282
+ === APT
213
283
 
214
- gemをアップグレードするには:
284
+ gemをアップグレードするには, 以下を使用してください:
215
285
 
216
286
  $ sudo apt-get upgrade -y asciidoctor
217
287
 
218
- TIP: お使いのシステムは自動的にdebパッケージをアップデートするよう設定されているかも知れません.その場合, gemのアップデートのためにあなたがすべきことはありません.
219
-
220
- パッケージマネージャ(apt-get)によってインストールされたバージョンのAsciidoctorは最新リリースのAsciidoctorではないかもしれません.
221
- ディストリビューションのリリース毎に, どのバージョンがパッケージされているかはパッケージリポジトリを調べてください.
222
-
223
- * https://packages.debian.org/search?keywords=asciidoctor&searchon=names&exact=1&suite=all&section=all[asciidoctor package by Debian release]
224
- * http://packages.ubuntu.com/search?keywords=asciidoctor&searchon=names&exact=1&suite=all&section=all[asciidoctor package by Ubuntu release]
225
- * https://community.linuxmint.com/software/view/asciidoctor[asciidoctor package by Mint release]
288
+ === DNF
226
289
 
227
- [CAUTION]
228
- ====
229
- パッケージマネージャによって管理されているgemをアップデートするのに `gem udpate` コマンドを使うなといわれるでしょう.
230
- そのようなことをするのは, パッケージマネージャがファイル(/usr/local下にインストールされた)を追跡できなくなるためにシステムが不安定な状態にするためです.
231
- 単純に, システムgemはパッケージマネージャによってのみ管理されるべきです.
290
+ gemをアップグレードするには, 以下を使用してください:
232
291
 
233
- もし, パッケージマネージャによってインストールされたのより新しいバージョンのAsciidoctorを使いたければ, http://rvm.io[RVM] https://github.com/rbenv/rbenv[rbenv]を使ってRubyをホームディレクトリ(すなわち, ユーザースペース)にインストールするべきです.
234
- それから, 安心して `gem` コマンドをAsciidoctorのアップデート, インストールのために使うことができます.
235
- RVMやrbenvを使っているなら, gemはシステムからは孤立した場所にインストールされます.
236
- ====
292
+ $ sudo dnf update -y asciidoctor
237
293
 
238
- ==== apk (Alpine Linux)
294
+ === Homebrew (macOS)
239
295
 
240
- Alpine Linuxにgemをインストールするには, ターミナルを開き, 以下を入力してください:
296
+ gemをアップグレードするには, 以下を使用してください:
241
297
 
242
- $ sudo apk add asciidoctor
298
+ $ brew update
299
+ $ brew upgrade asciidoctor
243
300
 
244
- gemをアップグレードするには:
301
+ === gem install
245
302
 
246
- $ sudo apk add -u asciidoctor
303
+ `gem` コマンドを使ってAsciidoctorをインストールした場合は, 新しいバージョンのAsciidoctorがリリースされたら手動でアップグレードする必要があります.
304
+ 以下を入力することでアップグレードできます:
247
305
 
248
- TIP: お使いのシステムは自動的にapkパッケージをアップデートするよう設定されているかも知れません.その場合, gemのアップデートのためにあなたがすべきことはありません.
306
+ $ gem install asciidoctor
249
307
 
250
- === Other installation options
308
+ `gem install` を使って新しいバージョンのgemをインストールすると, 複数のバージョンがインストールされた状態になります.
309
+ 以下のコマンドを使って古いバージョンを削除してください.
251
310
 
252
- * {uri-install-docker}[Installing Asciidoctor using Docker]
253
- * {uri-install-osx-doc}[Installing Asciidoctor on Mac OS X]
254
- // at the moment, the following entry is just a reiteration of the information in this README
255
- //* {uri-install-doc}[Installing the Asciidoctor toolchain]
311
+ $ gem cleanup asciidoctor
256
312
 
257
- == Usage
313
+ == 使い方
258
314
 
259
- Asciidoctorのインストールに成功すれば, `asciidoctor` コマンドラインインターフェース(CLI)がPATH中で有効になります.
260
- 確認のために, 以下をターミナルで実行しましょう:
315
+ Asciidoctorのインストールが成功すると, `asciidoctor` コマンドがPATHに存在するようになり, Asciidoctorのコマンドラインインターフェース(CLI)が使用できるようになります.
316
+ 確認のために, ターミナルで以下を実行しましょう:
261
317
 
262
318
  $ asciidoctor --version
263
319
 
264
- AsciidoctorのバージョンとRuby環境についての情報がターミナルに出力されたのを見ることができるはずです.
320
+ AsciidoctorのバージョンとRuby環境についての情報がターミナルに出力されるはずです.
265
321
 
266
322
  [.output,subs=attributes+]
267
323
  ....
268
- Asciidoctor {release-version} [http://asciidoctor.org]
269
- Runtime Environment (ruby 2.4.1p111 [x86_64-linux]) (lc:UTF-8 fs:UTF-8 in:- ex:UTF-8)
324
+ Asciidoctor {release-version} [https://asciidoctor.org]
325
+ Runtime Environment (ruby 2.6.0p0 [x86_64-linux]) (lc:UTF-8 fs:UTF-8 in:- ex:UTF-8)
270
326
  ....
271
327
 
272
- AsciidoctorはAPIを提供します.
273
- APIは他のRubyソフトウェア, Rails, SinatraGitHub, そして他の言語, Java (via {uri-asciidoctorj}[AsciidoctorJ] )JavaScript (via {uri-asciidoctorjs}[Asciidoctor.js])との統合を意図しています.
328
+ AsciidoctorはAPIも提供します.
329
+ APIは他のRubyソフトウェア, たとえばRails, Sinatra, GitHub, そして他の言語, たとえばJava ({uri-asciidoctorj}[AsciidoctorJ] 経由)JavaScript ({uri-asciidoctorjs}[Asciidoctor.js] 経由)と組み合わせて使用するためのものです.
274
330
 
275
- === Command line interface (CLI)
331
+ === コマンドラインインターフェース (CLI)
276
332
 
277
- `asciidoctor` コマンドはAsciidoctorをコマンドライン(つまりターミナル)から起動することを可能にします.
333
+ `asciidoctor` コマンドによりコマンドライン(つまりターミナル)からAsciidoctorを起動することができます.
278
334
 
279
- 次のコマンドはファイルREADME.adocHTMLに変換し, 結果を同じディレクトリのREADME.htmlに保存します.
280
- 生成されたHTMLファイルの名前はソースファイル依存し, その拡張子を `.html` に変えます.
335
+ 次のコマンドにより, README.adocというファイルがHTMLに変換され, 結果が同じディレクトリのREADME.htmlとして保存されます.
336
+ 生成されるHTMLファイルの名前は, ソースファイルのファイル名の拡張子を `.html` に替えたものとなります.
281
337
 
282
338
  $ asciidoctor README.adoc
283
339
 
284
- Asciidoctorプロセッサに様々なフラグやスイッチを与えることで制御できます.それは以下を用いて調べることができます:
340
+ さまざまなフラグやスイッチを与えることでAsciidoctorプロセッサをコントロールすることができます. フラグやスイッチの説明は以下のコマンドで表示されます:
285
341
 
286
342
  $ asciidoctor --help
287
343
 
288
- 例えば, ファイルを異なるディレクトリに書き出すには:
344
+ 例えば, ファイルを異なるディレクトリに書き出すには以下を使用します:
289
345
 
290
346
  $ asciidoctor -D output README.adoc
291
347
 
292
- `asciidoctor` {uri-manpage}[man page] はコマンドライン・インタフェースの完全なリファレンスを提供します.
348
+ コマンドラインインタフェースの完全なリファレンスは `asciidoctor` {uri-manpage}[manページ] にあります.
293
349
 
294
- `asciidoctor` コマンドの使い方についてもっと学ぶには以下を参照してください.
350
+ `asciidoctor` コマンドの使い方の詳細については以下を参照してください.
295
351
 
296
- * {uri-render-doc}[How do I convert a document?]
352
+ * {uri-convert-doc}[How do I convert a document?]
297
353
  * {uri-themes-doc}[How do I use the Asciidoctor stylesheet factory to produce custom themes?]
298
354
 
299
355
  === Ruby API
@@ -303,116 +359,114 @@ Asciidoctorをアプリケーションの中で使うには, まずgemをrequire
303
359
  [source]
304
360
  require 'asciidoctor'
305
361
 
306
- それから, AsciiDocソースファイルをHTMLファイルに変換できます:
362
+ そうすると, 以下のようにしてAsciiDocソースファイルをHTMLファイルに変換できます:
307
363
 
308
364
  [source]
309
365
  Asciidoctor.convert_file 'README.adoc', to_file: true, safe: :safe
310
366
 
311
- WARNING: AsciidoctorをAPI経由で使っている時, デフォルトのセーフモードは `:secure` です.
312
- セキュアモードでは, `include` ディレクティブを含むいくつかのコア機能は無効化されています.
313
- もしこれらの機能を有効化したい場合, 明示的にセーフモードを `:server` (推奨)か `:safe` にする必要があります.
367
+ WARNING: AsciidoctorをAPI経由で使っているとき, デフォルトのセーフモードは `:secure` (セキュアモード)です.
368
+ セキュアモードでは, `include` ディレクティブを含むいくつかのコア機能が無効化されています.
369
+ これらの機能を有効化したい場合, 明示的にセーフモードを `:server` (推奨)か `:safe` にする必要があります.
314
370
 
315
- AsciiDoc文字列を埋め込みHTML(HTMLページヘの挿入)へ変換することもできます:
371
+ AsciiDoc文字列を, 埋め込み用HTML(HTMLページヘの挿入用)に変換することもできます:
316
372
 
317
373
  [source]
318
374
  ----
319
- content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
375
+ content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
320
376
  Asciidoctor.convert content, safe: :safe
321
377
  ----
322
378
 
323
- もし完全なHTMLドキュメントを求めるのであれば, `header_footer` オプションを以下の通り有効にしてください:
379
+ もし完全なHTMLドキュメントが必要であれば, 以下のように `header_footer` オプションを有効にしてください:
324
380
 
325
381
  [source]
326
382
  ----
327
- content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
383
+ content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
328
384
  html = Asciidoctor.convert content, header_footer: true, safe: :safe
329
385
  ----
330
386
 
331
- パースされたドキュメントにアクセスしたいのなら, 変換を個々のステップに分割することが出来ます:
387
+ パースされたドキュメントにアクセスしたい場合は, 変換を複数のステップに分割します:
332
388
 
333
389
  [source]
334
390
  ----
335
- content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
391
+ content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
336
392
  document = Asciidoctor.load content, header_footer: true, safe: :safe
337
393
  puts document.doctitle
338
394
  html = document.convert
339
395
  ----
340
396
 
341
- Asciidoctorの生成する出力が気に入らないのであれば, _あなたはそれを変更できる_ ことを忘れないでください!
342
- Asciidoctorはパースされたドキュメントを生成された出力に変換する処理を扱うカスタムコンバーターをサポートしています.
397
+ Asciidoctorの生成する出力が気に入らない場合は, _あなたはそれを変更できる_ ことを忘れないでください!
398
+ パースされたドキュメントを出力形式に変換するコンバータは, カスタマイズが可能です.
343
399
 
344
- 断片的な出力をカスタマイズする簡単な方法の一つはテンプレートコンバーターを使うことです.
345
- テンプレートコンバーターによって, ドキュメント中のあらゆるノードの変換を扱うために {uri-tilt}[Tilt]-supportedテンプレートファイルを使うことができます.
400
+ 出力を部分的にカスタマイズする簡単な方法としてはテンプレートコンバータがあります.
401
+ テンプレートコンバータでは, ドキュメントの各ノードの変換に {uri-tilt}[Tilt]対応テンプレートファイルを使うことができます.
346
402
 
347
- そのようにすれば, 出力を100%制御することが _できます_ .
348
- APIの使い方や出力のカスタマイズ方法についてのより詳しい情報は {uri-user-manual}[user manual] を参照してください.
403
+ さまざまな方法を使って出力は100%制御することが _できます_ .
404
+ APIの使い方や出力のカスタマイズ方法についてのより詳しい情報は {uri-user-manual}[ユーザマニュアル] を参照してください.
349
405
 
350
- == Contributing
406
+ == コントリビューション
351
407
 
352
- {uri-freesoftware}[free software] の精神においては, _everyone_ がこのプロジェクトを改良するのをたすけることが勧められています.
353
- もしエラーや手抜かりをソースコード, ドキュメント, あるいはウェブサイトに見つけたのなら, 恥じることなく修正と共にpull requestの開設やissueの送信をしてください.
354
- New contributors are always welcome!
408
+ 新しいコントリビューションを常に歓迎します!
409
+ もしソースコード, ドキュメント, あるいはウェブサイトに間違いや不備を見つけたら遠慮なく, イシューを作成するか, 修正をおこなってpull requestを作成してください.
355
410
 
356
- *あなた* にもできることがあります:
411
+ *あなた* にもできることがあります:
357
412
 
358
- * 先行バージョン(alpha, beta or preview)の使用
413
+ * 先行バージョン(alpha, beta, またはpreview)の使用
359
414
  * バグレポート
360
415
  * 新機能提案
361
- * ドキュメントの執筆
362
- * 仕様の執筆
363
- * コーディング -- _パッチでも, 足りなすぎるなんてことはありません_
416
+ * ドキュメントの執筆または編集
417
+ * テストをつけてコードを書くこと -- _どのようなパッチであれ小さすぎるなどということはありません_
364
418
  ** typoの修正
365
419
  ** コメントの追加
366
420
  ** 一貫性のないホワイトスペースの除去
367
421
  ** テストの記述!
368
422
  * リファクタリング
369
- * {uri-issues}[issues] の修正
370
- * パッチの批評
423
+ * {uri-issues}[イシュー] の解決
424
+ * パッチのレビュー
371
425
 
372
- {uri-contribute}[Contributing] ガイドはどうやってスタイルをつくるか, issueを送るか, 機能リクエスト, コーディング, ドキュメンテーションをAsciidoctor Projectにするかについての情報を提供しています.
426
+ Asciidoctorプロジェクトにイシュー, 機能リクエスト, コード, ドキュメントを送る際の, 作成方法, スタイル, および送り方は, {uri-contribute}[Contributing] ガイドに記載されています.
373
427
 
374
- == Getting Help
428
+ == 助けを得る
375
429
 
376
- Asciidoctorプロジェクトはあなたが簡単に著作を書いて, 配布するのをたすけるため開発されています.
377
- しかしあなたのフィードバックなしにはできません!
378
- ディスカッションリストで, Twitterで, チャットルームで, 質問し, プロジェクトのあらゆる側面について話し合うようお勧めします.
430
+ Asciidoctorは, コンテンツの執筆と公開を簡単にするために開発されています.
431
+ しかしあなたからのフィードバックがなくてはAsciidoctorの開発は進みません!
432
+ ディスカッションリスト, Twitter, チャットルームを使って, 質問をしたりプロジェクトのさまざまな側面について話し合ったりすることをお勧めします.
379
433
 
380
- Discussion list (Nabble):: {uri-discuss}
381
- Twitter:: #asciidoctor hashtag or @asciidoctor mention
382
- Chat (Gitter):: image:https://badges.gitter.im/Join%20In.svg[Gitter, link=https://gitter.im/asciidoctor/asciidoctor]
434
+ チャット(Zulip):: {uri-chat}
435
+ ディスカッションリスト(Nabble):: {uri-discuss}
436
+ Twitter:: ハッシュタグ https://twitter.com/search?f=tweets&q=%23asciidoctor[#asciidoctor] またはメンション https://twitter.com/asciidoctor[@asciidoctor]
383
437
 
384
438
  ifdef::env-github[]
385
- 以下のプロジェクトサイトに、Asciidoctorに関するさらに詳しい情報やドキュメントがあります。
439
+ 以下のプロジェクトサイトに, Asciidoctorに関するさらに詳しい情報やドキュメントがあります.
386
440
 
387
- {uri-project}/[Home] | {uri-news}[News] | {uri-docs}[Docs]
441
+ {uri-project}[Home] | {uri-news}[News] | {uri-docs}[Docs]
388
442
  endif::[]
389
443
 
390
- GitHub上のAsciidoctorはプロジェクトのソースコード, イシュートラッカー, サブプロジェクトを管理しています.
444
+ GitHub上のAsciidoctorのorganizationではプロジェクトのソースコード, イシュートラッカー, サブプロジェクトが管理されています.
391
445
 
392
- Source repository (git):: {uri-repo}
393
- Issue tracker:: {uri-issues}
394
- Asciidoctor organization on GitHub:: {uri-org}
446
+ ソースリポジトリ(git):: {uri-repo}
447
+ イシュートラッカー:: {uri-issues}
448
+ GitHub上のAsciidoctororganization:: {uri-org}
395
449
 
396
- == Copyright and Licensing
450
+ == ライセンス
397
451
 
398
- Copyright (C) 2012-2018 Dan Allen, Ryan Waldron and the Asciidoctor Project.
399
- 本ソフトウェアはMITライセンスのもとで自由に使用できます.
452
+ Copyright (C) 2012-present Dan Allen, Sarah White, Ryan Waldron, and the individual contributors to Asciidoctor.
453
+ 本ソフトウェアはMITライセンスのもとで使用できます.
400
454
 
401
- 詳細は {uri-license}[LICENSE] ファイルを参照してください.
455
+ ライセンスの詳細については {uri-license}[LICENSE] ファイルを参照してください.
402
456
 
403
- == Authors
457
+ == 作者
404
458
 
405
- *Asciidoctor* は https://github.com/mojavelinux[Dan Allen] と https://github.com/graphitefriction[Sarah White] が先導し, Asciidoctorの素晴らしきコミュニティの数多くのメンバからコントリビューションを受けてきました.
406
- このプロジェクトは2012年から https://github.com/nickh[Nick Hengeveld] {uri-prototype}[プロトタイプ] をベースに https://github.com/erebor[Ryan Waldron] により創始されました.
459
+ *Asciidoctor* は https://github.com/mojavelinux[Dan Allen] と https://github.com/graphitefriction[Sarah White] がリードし, Asciidoctorの素晴らしきコミュニティの {uri-contributors}[数多くのメンバ] からコントリビューションを受けてきました.
460
+ このプロジェクトは https://github.com/nickh[Nick Hengeveld] のプロトタイプをベースに https://github.com/erebor[Ryan Waldron] により2012年から創始されました.
407
461
 
408
462
  *AsciiDoc* は Stuart Rackham により創始され, AsciiDocコミュニティの数多くのメンバからコントリビューションを受けてきました.
409
463
 
410
464
  ifndef::env-site[]
411
- == Changelog
465
+ == 変更履歴
412
466
 
413
467
  ifeval::[{safe-mode-level} < 20]
414
468
  include::CHANGELOG.adoc[tag=compact,leveloffset=+1]
415
469
  endif::[]
416
470
 
417
- リリースごとの変更一覧は {uri-changelog}[CHANGELOG] を参照してください.
471
+ 過去のリリースの完全な変更点リストについては {uri-changelog}[CHANGELOG] を参照してください.
418
472
  endif::[]