Introducción
En este artículo, quiero considerar las capacidades de Asciidoc en términos de garantizar el cumplimiento de los requisitos de los documentos con los requisitos de un sistema unificado para la documentación de diseño (ESKD), específicamente GOST R 2.105-9 (en adelante GOST ESKD). Por qué exactamente Asciidoc, escribí aquí .
Lo aclararé enseguida. El formato de los documentos no se trata aquí. El creador de la documentación no debería tener que preocuparse por el formato. Como analista de sistemas, creo contenido y controlo su estructura. Para obtener un documento que cumpla con GOST ESKD u otro estándar similar, tengo que presionar el botón y obtener un documento correctamente formateado en las opciones requeridas: pdf, Open Document (Libre
Office / Open Office), Open XML (Microsoft Word) y otros.
Después de trabajar en https://github.com/CourseOrchestra/asciidoctor-open-document , estoy seguro de
que todos los problemas de formato se resuelven con los esfuerzos adecuados.
Considere la estructura de un documento Asciidoc que cumpla con los requisitos de
GOST ESKD.
Construyendo un documento
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.
Puede olvidarse de los estilos de MS Word y concentrarse en el contenido de
los documentos que cree.