Introduction
In this article, I would like to consider the capabilities of Asciidoc in terms of ensuring the requirements for document compliance with the requirements of a unified system for design documentation (ESKD), specifically GOST R 2.105-9 (hereinafter GOST ESKD). Why exactly Asciidoc, I wrote here .
I'll clarify right away. Document formatting is not covered here. The creator of the documentation shouldn't have to worry about formatting. As a systems analyst, I create content and control its structure. To get a document that complies with GOST ESKD or another similar standard, I have to click the button and get a correctly formatted document in any required options: pdf, Open Document (Libre
Office / Open Office), Open XML (Microsoft Word) and others.
After working on https://github.com/CourseOrchestra/asciidoctor-open-document I am sure
that all formatting problems are solved with adequate efforts.
Consider the structure of an Asciidoc document that meets the requirements of
GOST ESKD.
Building a document
6.1.1 , Asciidoc .
= [preface] == == == == (, « ») [appendix] == (, « ») == == [bibliography] == ==
: « », . , , , : , (), () .. .
:mesto-sostavleniya:
, =
.
( 6.2 ) .
«» ( 6.3 ), «» ( 6.4. ) «» :
preface
Asciidoctor ,
;
appendix
;
bibliography
.
, [asciidoctor-bibtex] https://github.com/asciidoctor/asciidoctor-bibtex).
BibTeX.
@Book{viz, author = {, . .}, title = { }, publisher = {}, year = 1921, address = , lang=ru }
.
:bibtex-file: BibTeX , cite:[viz(24)]. [bibliography] == bibliography::[]
6.5 . // :
== === ====
secnums
.
Asciidoc (, ) , [.punkt]. .
[.punkt] ====
6.7 . Asciidoc :
. . . .. + .
: . , Asciidoc . .
, . +
.
. .
. * * . + *
Asciidoc .
, 1 ( 6.8.1).
. [cols="2,1,1,1,1", hrows=2] |==== .2+| 2+| 1 2+| 2 | 1.1 | 1.2 | 2.1 | 2.2 | 1 | | | | | 2 | | | | | 3 | | | | |====
. .
, , «». .
cols
(cols = "2,1,1,1,1"
) , 5 , .
hrows
. , .
hrows
Asciidoctor , https://github.com/CourseOrchestra/asciidoctor-plugins. options="header"
, ,
.
« » () , . 6.8.7 .
(|
). , .
, .2+|
. , , : 2+|
.
( 6.9 ) :
. image:: [ ]
, .
, .
, , . .
, . , . , . , , , , .
Open Document, , . . , . MS Word, .
Asciidoctor Asciidoctor Diagram , .
.
[plantuml, png] .... @startuml rectangle " 1" as c1 rectangle " 2" as c2 rectangle " 3" as c3 c1 <-> c2 c1 .. c3 c2 == c3 @enduml ....
:
, .
( 6.10 ) : . LaTeX/Mathematics:
[latexmath] ++++ \begin{bmatrix} a & b \\ c & d \end{bmatrix}\binom{n}{k} ++++
. Asciidoc, , - , .
[formula-poyasnenie] stem:[a] -- ; + stem:[b] -- ; + ..
stem
, .
+
. .
: , .. , .
( 6.11 ) Asciidoc : , , . , :
[[moya-diagramma]] . image::moya-diagramma.jpg[]
.
(<<moya-diagramma>>).
:
( 1).
html- (, ) « 1» .
, «» . , , — .
( 6.13 ) Asciidoc .
footnote:f1[ ]
f1 — , , .
Asciidoc .
Asciidoc 2.105—9.
You can forget about MS Word styles and concentrate on the content of
the documents you create.