Introdução
Neste artigo, quero considerar as capacidades da Asciidoc em termos de garantir os requisitos de conformidade dos documentos com os requisitos de um sistema unificado para documentação de design (ESKD), especificamente GOST R 2.105-9 (doravante GOST ESKD). Por que exatamente Asciidoc, eu escrevi aqui .
Vou esclarecer imediatamente. A formatação do documento não é abordada aqui. O criador da documentação não deve se preocupar com a formatação. Como analista de sistemas, crio conteúdo e controlo sua estrutura. Para obter um documento em conformidade com GOST ESKD ou outro padrão semelhante, tenho que pressionar o botão e obter um documento formatado corretamente em qualquer opção necessária: pdf, Open Document (Libre
Office / Open Office), Open XML (Microsoft Word) e outras.
Depois de trabalhar em https://github.com/CourseOrchestra/asciidoctor-open-document , estou certo de
que todos os problemas de formatação foram resolvidos com os esforços adequados.
Considere a estrutura de um documento Asciidoc que atende aos requisitos do
GOST ESKD.
Construindo um 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.
Você pode esquecer os estilos do MS Word e se concentrar no conteúdo dos
documentos que cria.