introduction
Dans cet article, je souhaite examiner les capacités d' Asciidoc en termes de garantie des exigences de conformité des documents avec les exigences d'un système unifié de documentation de conception (ESKD), en particulier GOST R 2.105-9 (ci-après GOST ESKD). Pourquoi exactement Asciidoc, j'ai écrit ici .
Je vais clarifier tout de suite. Le formatage des documents n'est pas traité ici. Le créateur de la documentation ne devrait pas avoir à se soucier du formatage. En tant qu'analyste de systèmes, je crée du contenu et contrôle sa structure. Pour obtenir un document conforme à GOST ESKD ou à une autre norme similaire, je dois appuyer sur le bouton et obtenir un document correctement formaté dans toutes les options requises: pdf, Open Document (Libre
Office / Open Office), Open XML (Microsoft Word) et autres.
Après avoir travaillé sur https://github.com/CourseOrchestra/asciidoctor-open-document, je suis sûr
que tous les problèmes de formatage sont résolus avec des efforts adéquats.
Considérez la structure d'un document Asciidoc qui répond aux exigences de
GOST ESKD.
Construire un 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.
Vous pouvez oublier les styles MS Word et vous concentrer sur le contenu des
documents que vous créez.