# Tech

ASCIIDOC АШИГЛАН БАРИМТ БИЧИГ(DOCUMENTATION) ХӨТЛӨХ ТАЛААР

2017-11-13

AsciiDoc гэж юу вэ?

AsciiDoc нь хүн уншихад илүү хялбар, ойлгомжтой болгосон баримт бичгийн хэлбэр гэж ойлгож болох бөгөөд тэмдэглэл хөтлөх, баримт бичиг бэлдэх, блог, цахим ном бичих зэрэгт ашиглагдаж тухайн текстийг AsciiDoc төрлөөс LateX, HTML, DocBook, Pdf, ePub г.м таш олон төрөл рүү хөрвүүлэх боломжтой түүл юм.


AsciiDoc ямар давуу талуудтай вэ?

AsciiDoc нь ямар ч нэмэлт таг юм уу эсвэл янз бүрийн форматад оруулах шаардлагагүй энгийн текст файл яаж бичдэгтэй адил шууд бичих боломжтой бөгөөд asciidoc төрлийн файлаас хүссэн формат уруугаа хялбархан хөрвүүлэх боломжтойгоороо давуу талтай.

= Introduction to AsciiDoc
Doc Writer <doc@example.com>

A preface about http://asciidoc.org[AsciiDoc].

== First Section

* item 1
* item 2

[source,ruby]
puts "Hello, World!" 

AsciiDoc-н энгийн жишээ:

HTML хэлбэрт хөрвүүлэн browser дээр харвал:

Дээр бичигдсэн asciidoc файлыг баримт бичиг хөтлөхөд их хэрэглэгдэж байгаа DocBook төрөл рүү хувиргаж бичвэл:

Дараах байдлаар бичигдэх ба DocBook, HTML төрлийн файл бичиглэлийн хувьд хөгжүүлэгчдийн хувьд тийм ч төвөгтэй биш боловч asciidoc төрлийн файлтай харьцуулахад уншиж ойлгоход тийм ч энгийн амархан байж чадахгүй байгаа нь дээрхээс бичиглэлийн зөрүүнээс харагдаж байна.


AsciiDoc Installation

1. Installation on Ubuntu 16.04 LTS

*Option 1 ( install latest version )

# Update system
$ sudo apt-get update

# Install AsciiDoc
$ sudo apt-get install asciidoc

*Option 2 ( install specific version from Git )

$ cd ~/bin
$ git clone https://github.com/asciidoc/asciidoc asciidoc-8.6.9
$ git checkout 8.6.9

# Create symlink
$ ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc
$ ln -s ~/bin/asciidoc-8.6.9/a2x.py ~/bin/a2x #a2x used for asciidoc file to convert other format such as pdf etc..

$ autoconf
$ ./configure
$ make
$ sudo make install

# To uninstall AsciiDoc
$ sudo make uninstall

2. Installation on Microsoft Windows

# Binary installer file of Ascii
https://code.google.com/archive/p/asciidoc-win32/

3. Installation on MacOS

# Gist дээрх MacOS дээр суулгах заавар  
https://gist.github.com/dustinschultz/6554087 

::Asciidoc-г хэрхэн ашиглах талаар

1. Үйлдлийн систем дээр амжилттай суулгасны дараа дурын текст засах програмаар шинэ файл үүсгэн 
http://powerman.name/doc/asciidoc дээрх зааврын дагуу баримт бичиг үүснэ.

2. Үүсгэсэн текст файлаа DocBook эсвэл HTML төрөл рүү хөрвүүлэхийн тулд доорх коммандийг ашиглана 
 asciidoc [OPTIONS] FILE 
*[OPTIONS]- дэлгэрэнгүй тайлбарыг http://asciidoc.org/manpage.html-с харж болно.
* FILE- шинээр үүсгэсэн текст файлын нэр 

* Текст файлаа бусад формат руу хувиргахын тулд A2x ашиглана. 
 a2x [OPTIONS] SOURCE_FILE
*[OPTIONS]- дэлгэрэнгүй тайлбарыг http://asciidoc.org/a2x.1.html-с харж болно.

Шинээр баримт бичиг хөтөлж байгаа үед байнга текст файл өөрчлөгдөх болгонд түүл ашиглан хөрвүүлж өөрчлөлтүүдийг харахад цаг алдах болон нэг үйлдлээ олон дахин давтах зэрэг ашиггүй үйлдлүүд хийхгүйн тулд Атом дээрх “AsciiDoc Live preview” plug-in ашиглаж болох юм.

* Atom plugin – ийг хэрхэн суулгаж ашиглах зааврыг https://tedbergeron.github.io/2015/03/29/Atom-Editor-for-Ascii-Doc.html – ээс харна уу.

Хөгжүүлэлтийн орчин бэлдэх болон тухайн төслийн талаар сайн Documentation бэлдэх хэрэгтэй гэдгийг хүн болгон мэддэг хэдий ч яг амьдрал дээр ихэнх төслүүд “well documented” байж чаддаггүй гэдэгтэй ихэнх хүмүүс санал нийлэх байх. Тийм болохоор энэ постыг уншаад өнгөрөх биш asciidoc-г юм уу эсвэл илүү хялбар түүлийг ашиглаад ажиллаж байгаа төслийнхөө “documantation” хэсгийг сайжруулцгаая \xF0\x9F\x99\x8F.

Эх сурвалж:

Сэтгэгдэл

gerelmaa.n