AsciiDoc მომხმარებლის სახელმძღვანელო ==================================== Stuart Rackham :Author Initials: SJR :Translator: David Avsajanishvili .მარტივი დოკუმენტაცია [caption="მაგალითი: "] --------------------------------------------------------------------- პროგრამის ფუნქციების აღწერა =========================== დ.ავსაჯანიშვილი v1.0,2009-02-09 ამ დოკუმენტში აღწერილია პროგრამის ძირითადი ფუნქციები მომხმარებლის ინტერფეისი ----------------------- მომხმარებლის ინტერფეისი მოიცავს შემდეგს: . მთავარი ფანჯარა . მენიუ . პანელი .. ძირითადი .. დამხმარე . გამოსვლის ღილაკი მთავარი ფანჯარა ~~~~~~~~~~~~~~~ პროგრამის მთავარ ფანჯარას შემდეგი სახე აქვს: image::main_window.jpg[] მენიუს პუნქტები ~~~~~~~~~~~~~~~ მთავარი მენიუ შემდეგ ძირითად პუნქტებს შეიცავს: ფაილი:: ფაილის გახსნა, შენახვა პროგრამიდან გამოსვლა... რედაქტირება:: დოკუმენტის რედაქტირების ბრძანებები. დათვალიერება:: ვიზუალური წარმოდგენის რეჟიმები: მაშტაბი, სახაზავები და სხვა.. დახმარება:: დახმარება და პროგრამის შესახებ ინფორმაცია. პროგრამასთან მუშაობა -------------------- ამ სექციაში აღწერილია პროგრამასთან მუშაობის ძირითადი პრინციპები. --------------------------------------------------------------------- დოკუმენტის სტრუქტურა -------------------- AsciiDoc დოკუმენტი <> მიმდევრობისაგან შედგება. დოკუმენტი იწყება ჰედერით, რომელსაც მოსდევს შესავალი და დოკუმენტის სექციები. [[X8]] ბლოკის ელემენტები ~~~~~~~~~~~~~~~~ ბლოკის ელემენტი შედგება ერთი ან ერთზე მეტი ტექსტური სტრიქონისაგან, და შეიძლება შეიცავდეს სხვა ბლოკის ელემენტებს. AsciiDoc ბლოკის სტრუქტურა შემდეგი სახით შეიძლება წარმოვიდგინოთ: [cols=">5,1,10"] |==================================================================== | დოკუმენტი |::= |(ჰედერი?,შესავალი?,სექცია*) | ჰედერი |::= |(სახელწოდება,(ავტორი,რევიზია?)?) | ავტორი |::= |(სახელი,(მამის_სახელი?,გვარი)?,ელ_ფოსტა?) | რევიზია |::= |(ვერსია?,თარიღი) | შესავალი |::= |(ტექსტი) | სექცია |::= |(სათაური,ტექსტი?,(სექცია)*) | ტექსტი |::= |((ტექსტის_სათაური?,ბლოკი)\|ბლოკის_მაკროსი)+ | ბლოკი |::= |(პარაგრაფი\|დაყოფილი_ბლოკი\|სია\|ცხრილი) | სია |::= |(მარკერებიანი_სია\|დანომრილი_სია\|სია_იდენტიფიკატორებით) | მარკერებიანი_სია |::= |(სიის_ელემენტი)+ | დანომრილი_სია |::= |(სიის_ელემენტი)+ | სია_იდენტიფიკ-ბით |::= |(სიის_ელემენტი)+ | სიის_ელემენტი |::= |(ელემენტის_ტექსტი,(სია\|სიის_პარაგრაფი\|სიის_გაგრძელება)*) | ცხრილი |::= |(სახაზავი,ცხრილის_ჰედერი?,ცხრილის_სხეული,ცხრილის_ფუტერი?) | ცხრილის_ჰედერი |::= |(ცხრილის_სტრიქონი+,ცხრილის_ხაზგასმა) | ცხრილის_ფუტერი |::= |(ცხრილის_სტრიქონი+,ცხრილის_ხაზგასმა) | ცხრილის_სხეული |::= |(ცხრილის_სტრიქონი+,ცხრილის_ხაზგასმა) | ცხრილის_სტრიქონი |::= |(მონაცემები+) |==================================================================== სადაც: - პირობითი აღნიშვნები: * '?' -- არააუცილებელი მნიშვნელობა, * '+' -- ერთი (აუცილებელი) ან ერთზე მეტი მნიშვნელობა, * '*' -- არააუცილებელი ერთი ან ერთზე მეტი მნიშვნელობა. - ბლოკის ელემენტები ერთმანეთისაგან გამოიყოფა ერთი ან რამდენიმე ცარიელი ხაზით. - შემდეგი ელემენტები არ შეიძლება შეიცავდეს ცარიელ სტრიქონებს: ჰედერი, დასახელება, პარაგრაფი, ელემენტის_ტექსტი. - სიის_გაგრძელება წარმოადგენს სპეციალურ <>. ჰედერი ~~~~~~~ ჰედერი არის არააუცილებელი, მაგრამ აუცილებლად უნდა იყოს დოკუმენტის პირველ სტრიქონში განთავსებული, და უნდა იწყებოდეს <>. ავტორი და რევიზია უშუალოდ მოსდევს სათაურს. ჰედერს შეიძლება წინ უსწრებდეს <> ან <>. ავტორის ხაზი შედგება ავტორის სახელისაგან, რომელსაც მოსდევს არააუცილებელი ელ.ფოსტის მისამართი, მოთავსებული კუთხიან ფრჩხილებში: ავტორის სახელი შედგება 2 ან 3 სიტყვისაგან, რომლებიც ერთმანეთსაგან პრობელით არის გამოყოფილი. რევიზია აგრეთვე არის არააუცილებელი და უნდა იყოს წარმოდგენილი შემდეგ ფორმატში: . ასოებისაგან და ციფრებისაგან შემდგარი ვერსია, რომელსაც მოსდევს თარიღი: - ვერსიის ნომერი და თარიღი ერთმანეთისაგან გამოყოფილია მძმით. - ვერსიის ნომერი არააუცილებელია, მაგრამ ერთ ციფრს მაინც უნდა შეიცავდეს. - ყველა არაციფრული სიმბოლო, რომელიც წინ უსწრებს ციფრს ვერსიის ნომერში, ამოგდებული იქნება. . RCS/CSV/SVN ##$##Id##$## ნიშანი. დოკუმენტის ჰედერი გამოიყოფა დოკუმენტისაგან ერთი ან მეტი ცარიელი ხაზით. მაგალითი: ------------------------------------- AsciiDoc-ის დოკუმენტი ==================== დავით ავსაჯანიშვილი v2.0, 2008-04-10 ------------------------------------- შესავალი ~~~~~~~~ შესავალი არის არააუცილებელი უსათაურო სექცია, მოთავსებული დოკუმენტის ჰედერსა და პირველი სექციის სათაურს შორის. სექცია ~~~~~~ AsciiDoc დოკუმენტი შეიძლება შეიცავდეს 1-დან 4-მდე სექციის დონეს. სექციის დონე განისაზღვრება სექციის <>. [[X16]] სპეციალური სექციები ^^^^^^^^^^^^^^^^^^^ ჩვეულებრივების გარდა, დოკუმენტი შეიძლება შეიცავდეს სპეციალურ საწყის და საბოლოო სექციებს -- მაგალითად: preface, bibliography, table of contents, index. ტექსტის ფორმატირება -------------------- [[X51]] ფორმატირებული ტექსტი ~~~~~~~~~~~~~~~~~~~~ სიტყვები და ფრაზები შეიძლება გავაფორმოთ ფორმატით სპეციალურ სიმბოლოებში მოქცევით: _გამოყოფილი ტექსტი_:: ფრაზები, მოქცეული \'ერთმაგ ბრჭყალებში' (აპოსტროფებში) ან \_ხაზგასმის ნიშნებში_ დოკუმენტში ჩანს გამოყოფილად, როგორც წესი კურსივად. *ბოლდი*:: ფრაზები, მოქცეული \*ვარსკვლავის ნიშნებში* დოკუმენტში ჩანს ბოლდად. +თანაბარი სიგანის ტექსტი+:: ფრაზები, მოქცეული\`უკუღმა ერთმაგ ბრჭყალებში` ან \+პლიუსებში+ დოკუმენტში ჩანს თანაბარი სიგანის შრიფტით. ``ბრჭყალები'':: ფრაზები, გამოყოფილი \``ორი უკუღმა ერთმაგი ბრჭყალით მარცხნიდან და ორი ერთმაგი ბრჭყალით მარჯვნიდან\'' მოიქცევა ბრჭყალებში. #სპეციალური ფორმატირება#:: ტექსტის მოთავსება \#მესრის ნიშნებში# საშუალებას გვაძლევს სხვადასხვა სახით დავაფორმატიროთ ტექსტი ატრიბუტების მეშვეობით. .გამოყოფილი ტექსტის თვისებები - გადაფარვა დაუშვებელია. - გამოყოფის სხვადასხვა ტიპები შეიძლება იყოს ჩადგმული. - იმისათვის, რომ გამოვიტანოთ თვით ფორმატირების ნიშნები, (მაგ., ვარსკვლავების წყვილები, პლიუსის წყვილები) პირველი ნიშნის წინ უნდა მოვათავსოთ უკუღმა დახრილი ხაზი. [[X52]] შეზღუდული და შეუზღუდავი ფორმატირება ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ სინამდვილეში, ფორმატირების ორი ხერხი არსებობს: შეზღუდული ფორმატირება ++++++++++++++++++++++ ფორმატირებული ტექსტი უნდა იყოს გამოყოფილი სხვა ტექსტისაგან პრობელით. ამ გზით შეიძლება მხოლოდ მთლიანად სიტყვების და ფრაზების ფორმატირება. შეუზღუდავი ფორმატირება ++++++++++++++++++++++ შეუზღუდავი ფორმატირებით შეიძლება დავაფორმატიროთ არამარტო სიტყვები და ფრაზები, არამედ ცალკეული სიმბოლოებიც კი. სიმარტივისათვის, შეუზღუდავი ფორმატირებისათვის გამოიყენება იგივე სიმბოლოები, ოღონდ გადუბლირებული: -------------------------------------------------- __შეუზღუდავი კურსივით გამოყოფილი ტექსტი__ **შეუზღუდავი ბოლდი** ++შეუზღუდავი თანაბარი სიგანის სიმბოლოები++ ##შეუზღუდავი სპეციალური ფორმატირების ტქსტი## -------------------------------------------------- შემდეგ მაგალითში მხოლოდ ასო F იქნება ბოლდი: **F**ile Open... ********************************************************************* **F**ile Open... ********************************************************************* [[X50]] ფორმატირების გვერდით ავლა ~~~~~~~~~~~~~~~~~~~~~~~~~ სპეციალური მექანიზმი გამოიყენება ფორმატირების გვერდით ავლისათვის: \+\++სამი პლიუსის ნიშანი\+\++:: სამ-სამ პლიუსის ნიშანში მოქცეული ტექსტი გადადის პირდაპირ, ყოველგვარი ფორმატირების გარეშე. \$$ორი დოლარის ნიშანი$$:: იგივე, ოღონდ სპეციალური სიმბოლოების ჩანაცვლება ხდება (მეტობის და ნაკლებობის ნიშნები, ამპერსანდი). დოლარებში მოქცეული ტექსტი შეიძლება დავაფორმატიროთ ატრიბუტების მეშვეობით. სუბსკრიპტი და სუპერსკრიპტი ~~~~~~~~~~~~~~~~~~~~~~~~~ მოათავსეთ ტექსტი \^ხარისხის აყვანის ნიშნებშ^ სუპერსკრიპტის მისაღებად. მოათავსეთ ტექსტი \~ტილდის ნიშნებში~ სუბსკრიპტის მისაღებად. მაგ., შემდეგი ხაზი: e^{amp}#960;i^+1 = 0. H~2~O and x^10^. Some ^super text^ and ~some sub text~ დააფორმირებს ტექსტს: e^{amp}#960;i^+1 = 0. H~2~O and x^10^. Some ^super text^ and ~some sub text~ სუბსკრიპტი და სუპერსკრიპტი წარმოადგენს <>. ჰორიზონტალური ხაზები ~~~~~~~~~~~~~~~~~~~~ ოთხი ან მეტი ერთმაგი აპოსტროფებისაგან შემდგარი ხაზი აფორმირებს ჰორიზონტალურ ხაზს: --------------------------------------------------------------------- '''''''''''''''''''' --------------------------------------------------------------------- ჩანაცვლებები ~~~~~~~~~~~~ შემდეგი ჩანაცვლებები შეიძლება იქნეს გამოყენებული დოკუმენტში: -------------------------------------------- (C) კოპირაიტი, (TM) ტრეიდმარკი, (R) რეგისტრირებული ტრეიდმარკი, -- გრძელი დეფისი, ... მრავალწერტილი. -------------------------------------------- აისახება შემდეგნაირად: (C) კოპირაიტი, (TM) ტრეიდმარკი, (R) რეგისტრირებული ტრეიდმარკი, -- გრძელი დეფისი, ... მრავალწერტილი. [[X17]] სათაურები ----------- სათაურის წარმოდგენა შეიძლება ორი სხვადასხვა ფორმატით: ხაზგასმული სათაურები ~~~~~~~~~~~~~~~~~~~ ხაზგასმული სათაური შედგება სათაურის ტექსტისაგან, რომელსაც წინ არ უსწრებს პრობელები და პუნქტუაციის ნიშნები, და ხაზგასმისაგან მომდევნო ხაზზე. ხაზგასმა შედგება გამეორებული სიმბოლოებისაგან, რომელთა რაოდენობა უდრის სათაურში ასოების რაოდენობას (განსხვავება უნდა იყოს არაუმეტეს 3 სიმბოლო): -------------------------------- დონე 0 (ზედა დონე): ====================== დონე 1: ---------------------- დონე 2: ~~~~~~~~~~~~~~~~~~~~~~ დონე 3: ^^^^^^^^^^^^^^^^^^^^^^ დონე 4 (ქვედა დონე): ++++++++++++++++++++++ -------------------------------- მაგალითები: Level One Section Title ----------------------- Level 2 Subsection Title ~~~~~~~~~~~~~~~~~~~~~~~~ [[X46]] ერთხაზიანი სათაურები ~~~~~~~~~~~~~~~~~~~ ერთხაზიანი სათაურები შედგება ერთ ხაზში მოქცეული ტექსტისაგან, რომელიც ორივე მხრიდან გამოყოფილია პრობელებით და 1-დან 5-მდე ტოლობის ნიშნით. ტოლობის ნიშნების რაოდენობა განსაზღვრავს სათაურის დონეს: = Document Title (level 0) = == Section title (level 1) == === Section title (level 2) === ==== Section title (level 3) ==== ===== Section title (level 4) ===== .შენიშვნა - ერთი ან რამდენიმე პრობელი უნდა იყოს ტოლობის ნიშნებსა და ტექსტს შორის. [[X42]] ბლოკის_სათაური -------------- ბლოკის_სათაური არის ერთი სტრიქონი, რომელიც იწყება წერტილით (.), რომელსაც მოსდევს სათაური. იგი განმარტავს შემდგომ პარაგრაფს, გამოყოფილ_ბლოკს, სიას ან ცხრილს. მაგალითად: ........................ .Notes - Note 1. - Note 2. ........................ აისახება შემდეგნაირად: .Notes - Note 1. - Note 2. [[X41]] ბლოკის_ID ელემენტი ------------------- 'ბლოკის_ID' არის ერთსტრიქონიანი ელემენტი, რომელიც შეიცავს უნიკალურ იდენტიფიკატორს, მოქცეულს ორმაგ კვადრატულ ფრჩხილებში. იგი გამოიყენება დოკუმენტის სხვა ადგილიდან მიმართვისათვის ბმულის მეშვეობით. მაგალითად: ----------------------------- [[chapter-titles]] სათაურები ... ----------------------------- ეს მაგალითი განსაზღვრავს მოცემული პარაგრაფის ბლოკის_ID-ს, და მასზე მიმართვა შესაძლებელია დოკუმენტის სხვა ადგილიდან, მაგალითად ასე: `\<>`. 'ბლოკის_ID' ელემენტები შეიძლება გავუკეთოთ სათაურს, პარაგრაფს, სიას, დაყოფილ_ბლოკს და ცხრილს. 'ბლოკის_ID' ელემენტს აქვს იგივე სინტაქსი, და ასრულებს იგივე მოვალეობას, რაც <>. პარაგრაფები ----------- პარაგრაფები მთავრდება ცარიელი სტრიქონით, ფაილის დასასრულით ან გამოყოფილი_ბლოკის დასაწყისით. წინსაწარ განსაზღვრულია პარაგრაფის შემდეგი ტიპები: ჩვეულებრივი პარაგრაფი ~~~~~~~~~~~~~~~~~~~~~ ჩვეულებრივი პარაგრაფი შედგება ერთი ან მეტი არაცარიელი ტექსტური ხაზისაგან. პირველი ხაზი არ უნდა იწყებოდეს პრობელით. დოკუმენტში იგი აისახება ჩვეულებრივი ტექსტური პარაგრაფის სახით. ჩვეულებრივ პარაგრაფში ახალ ხაზზე გადატანა არანაირ მოქმედებას არ იწვევს (ე.ი. შედეგად ვიღებთ ტექსტის ჩვეულებრივ გაგრძელებას. გამონაკლისს წარმოადგენს 'verse' სტილის პარაგრაფი, რომელიც ითვალისწინებს ახალ ხაზზე გადატანას. მაგალითად: --------------------------------------------------------------------- [verse] Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui. --------------------------------------------------------------------- აისახება ასე: [verse] Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui. პირდაპირი პარაგრაფი ~~~~~~~~~~~~~~~~~~~ პირდაპირი პარაგრაფი შედგება ერთი ან რამდენიმე ტექსტური სტრიქონისაგან, სადაც პირველი ხაზი გამოყოფილია ერთი ან რამდენიმე პრობელით მარცხვნიდან. პირდაპირი პარაგრაფის ტექსტი აისახება ცვლილებების გარეშე, თანაბარი ზომის შრიფტით, ყოველგვარი საზღვრების და ფონის გარეშე. მაგალითად: --------------------------------------------------------------------- Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui. --------------------------------------------------------------------- მივიღებთ შედეგს: Consul *necessitatibus* per id, consetetur, eu pro everti postulant homero verear ea mea, qui. [[X28]] შენივნის პარაგრაფი ~~~~~~~~~~~~~~~~ 'Tip', 'Note', 'Important', 'Warning' და 'Caution' პარაგრაფები შეიცავს სტანდარტული ტიპის შენიშვნებს -- უბრალოდ მოათავსეთ შესაბამისი სიტყვა (`NOTE:`, `TIP:`, `IMPORTANT:`,`WARNING:` ან `CAUTION:`) პარაგრაფის პირველ ხაზად. მაგალითად: ------------------------------------- NOTE: შენიშვნის მაგალითი. ------------------------------------- არსებობს ალტერნატიული სინტაქსი: ------------------------------------- [NOTE] შენიშვნლის მაგალითი. ------------------------------------- შედეგი ასეთია: NOTE: შენიშვნლის მაგალითი. TIP: თუ თქვენი შენიშვნა ერთ პარაგრაფზე მეტია, გამოიყენეთ <>. გამოყოფილი_ბლოკი ---------------- გამოყოფილი ბლოკი არის ტექსტის ბლოკი, მოთავსებული გამყოფის ხაზებში ზემოდან და ქვემოდან (4 ან მეტი გადუბლირებული სიმბოლო). წინასწარ განსაზღვრული გამოყოფილი ბლოკები ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ AsciiDoc-ს მოჰყვება რამდენიმე წინასწარ განსაზღვრული გამოყოფილი ბლოკი: CommentBlock: ////////////////////////// PassthroughBlock: ++++++++++++++++++++++++++ ListingBlock: -------------------------- LiteralBlock: .......................... SidebarBlock: ************************** QuoteBlock: __________________________ ExampleBlock: ========================== OpenBlock: -- .გამოყოფილ ბლოკებში შენაცვლებების შესაძლებლობა [cols="2s,7*^",options="header,autowidth"] |===================================================== | |Attributes |Callouts |Macros | Quotes |Replacements |Special chars |Special words |PassthroughBlock |Yes |No |Yes |No |No |No |No |ListingBlock |No |Yes |No |No |No |Yes |No |LiteralBlock |No |Yes |No |No |No |Yes |No |SidebarBlock |Yes |No |Yes |Yes |Yes |Yes |Yes |QuoteBlock |Yes |No |Yes |Yes |Yes |Yes |Yes |ExampleBlock |Yes |No |Yes |Yes |Yes |Yes |Yes |OpenBlock |Yes |No |Yes |Yes |Yes |Yes |Yes |===================================================== ამონაბეჭდის ბლოკი ~~~~~~~~~~~~~~~~ ამონაბეჭდები აისახება პირდაპირ, ცვლილებების გარეშე, თანაბარი სიგანის შრიფტით, ისინი ინარჩუნებს ყველა პრობელს და ხაზზე გადატანებს და გამოიყოფა სხვა ტექსტისაგან ფონით და საზღვრებით. როგორც წესი გამოიყენება პროგრამის და ფაილების სიის წარმოსადგენად. მაგალითი: -------------------------------------- #include int main() { printf("Hello World!\n"); exit(0); } -------------------------------------- აისახება შემდეგნაირად: -------------------------------------- #include int main() { printf("Hello World!\n"); exit(0); } -------------------------------------- პირდაპირი ბლოკი ~~~~~~~~~~~~~~~~ გამოიყურება იგივენაირად, რაც პირდაპირი პარაგრაფი, იმ განსხვავებით, რომ პირველ ხაზში ადგილის გამოტოვება აღარ არის საჭირო. --------------------------------------------------------------------- .................... 1. Item 1 2. Item 2 .................... --------------------------------------------------------------------- გვაძლევს შედეგს: .................... 1. Item 1 2. Item 2 .................... გამოტანა ~~~~~~~~ გამოიყენება ტექსტის ნაწილის დანარჩენი ტექსტისაგან გამოსაყოფად: --------------------------------------------------------------------- .გამოტანის მაგალითი ************************************************ Any AsciiDoc SectionBody element (apart from SidebarBlocks) can be placed inside a sidebar. ************************************************ --------------------------------------------------------------------- შემდეგ სახეს მიიღებს: .გამოტანის მაგალითი ************************************************ Any AsciiDoc SectionBody element (apart from SidebarBlocks) can be placed inside a sidebar. ************************************************ [[X26]] კომენტარი ~~~~~~~~~ კომენტარის შემცველობა საბოლოო დოკუმენტში არ ჩანს, იგი მოსახერხებელია შიდა შენიშვნებისათვის და არსებული ტექსტის დაბლოკვის მიზნით. მაგალითი: --------------------------------------------------------------------- ////////////////////////////////////////// CommentBlock contents are not processed by asciidoc(1). ////////////////////////////////////////// --------------------------------------------------------------------- იხილე აგრეთვე <>. ციტატის ბლოკი ~~~~~~~~~~~~~~ არსებობს ორი ტიპის ციტატის ბლოკი: 'quote' და 'verse' (1 ატრიბუტი). ციტირების ბლოკს შეიძლება ჰქონდეს 'attribution' და 'citetitle' ატრიბუტები (მე-2 და მე-3), რომელიც მიუთითებს ავტორს და წყაროს. ბლოკის ტიპი და სხვა ატრიბუტები უნდა მოვათავსოთ კვადრატულ ფრჩხილებში, ციტატის წინ. მაგალითად: --------------------------------------------------------------------- [quote, Bertrand Russell, The World of Mathematics (1956)] ____________________________________________________________________ A good notation has subtlety and suggestiveness which at times makes it almost seem like a live teacher. ____________________________________________________________________ --------------------------------------------------------------------- გვაძლევს შედეგს: [quote, Bertrand Russell, The World of Mathematics (1956)] ____________________________________________________________________ A good notation has subtlety and suggestiveness which at times makes it almost seem like a live teacher. ____________________________________________________________________ 'verse' სტილის გამოყენებისას ახალ ხაზზე გადასვლა შენარჩუნდება: --------------------------------------------------------------------- [verse,William Blake,from Auguries of Innocence] _____________________________________________________________________ To see a world in a grain of sand, And a heaven in a wild flower, Hold infinity in the palm of your hand, And eternity in an hour. _____________________________________________________________________ --------------------------------------------------------------------- შედეგი ასეთია: [verse,William Blake,from Auguries of Innocence] _____________________________________________________________________ To see a world in a grain of sand, And a heaven in a wild flower, Hold infinity in the palm of your hand, And eternity in an hour. _____________________________________________________________________ [[X48]] მაგალითის ბლოკი ~~~~~~~~~~~~~~~ მაგალითის ბლოკი გამოიყენება მაგალითების გამოსატანად. მას შეიძლება წინ უსწრებდეს ბლოკის_სათაური. მაგალითში ნებისმიერი ბლოკის ჩართვა შეიძლება, გარდა სათაურის, ბლოკის_სათაურის და გამოტანისა. მაგალითი: --------------------------------------------------------------------- .An example ===================================================================== Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. ===================================================================== --------------------------------------------------------------------- შედეგი: .An example ===================================================================== Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. ===================================================================== [[X22]] შენიშვნლის ბლოკი ~~~~~~~~~~~~~~~~ მაგალითის ბლოკს წინ შეიძლება უსწრებდეს შენიშვნის სტილის მაჩვენებელი (NOTE, TIP, IMPORTANT, WARNING, CAUTION), რათა მივიღოთ შენიშვნის ბლოკი: --------------------------------------------------------------------- [NOTE] .A NOTE block ===================================================================== Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. . Fusce euismod commodo velit. . Vivamus fringilla mi eu lacus. .. Fusce euismod commodo velit. .. Vivamus fringilla mi eu lacus. . Donec eget arcu bibendum nunc consequat lobortis. ===================================================================== --------------------------------------------------------------------- შედეგი: [NOTE] .A NOTE block ===================================================================== Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. . Fusce euismod commodo velit. . Vivamus fringilla mi eu lacus. .. Fusce euismod commodo velit. .. Vivamus fringilla mi eu lacus. . Donec eget arcu bibendum nunc consequat lobortis. ===================================================================== სიები ----- .სიების ტიპები - მარკერებიანი. - დანომრილი. - განსაზღვრებებიანი. - ანოტირებული. .სიის თვისებები - ადგილის გამოყოფა არ არის აუცილებელი და ზეგავლენას არ ახდენს ჩადგმულობაზე, თუმცა წყაროს წაკითხვის თვალსაზრისით მოსახერხებელია. - ჩადგმული სია უნდა იყოს სხვა სტილის, რათა მოხდეს მისი იდენტიფიცირება. - გამოიყენეთ <> სხვა ბლოკის სიაში ჩასართავად. მარკერებიანი და დანომრილი სია ~~~~~~~~~~~~~~~~~~~~~~~~~~~ მარკერებიანი სიის ელემენტი იწყება მინუსის ან ვარსკვლავის ნიშნით, რომელსაც მოსდევს ერთი პრობელი: ---------------------- - ელემენტი. * ელემენტი. ---------------------- დანომრილი სიის ელემენტი იწყება ციფრით ან ასოთი, რომელსაც მოსდევს წერტილი და პრობელი, ციფრი და ასო აუცილებელი არ არის. ასოებით დანომრვის მისაღებად ორი წერტილი გამოიყენება: ---------------------- . დანომრილი ელემენტი. 1. დანომრილი ელემენტი (ნომრით). .. ასოებით დანომრილი ელემენტი. a. ასოებით დანომრილი ელემენტი (ასოს მითითებით). ---------------------- მაგალითები: --------------------------------------------------------------------- - Lorem ipsum dolor sit amet, consectetuer adipiscing elit. * Fusce euismod commodo velit. * Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel. * Vivamus fringilla mi eu lacus. * Donec eget arcu bibendum nunc consequat lobortis. - Nulla porttitor vulputate libero. . Fusce euismod commodo velit. . Vivamus fringilla mi eu lacus. .. Fusce euismod commodo velit. .. Vivamus fringilla mi eu lacus. . Donec eget arcu bibendum nunc consequat lobortis. - Praesent eget purus quis magna eleifend eleifend. 1. Fusce euismod commodo velit. a. Fusce euismod commodo velit. b. Vivamus fringilla mi eu lacus. c. Donec eget arcu bibendum nunc consequat lobortis. 2. Vivamus fringilla mi eu lacus. 3. Donec eget arcu bibendum nunc consequat lobortis. 4. Nam fermentum mattis ante. --------------------------------------------------------------------- შედეგი: - Lorem ipsum dolor sit amet, consectetuer adipiscing elit. * Fusce euismod commodo velit. * Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel. * Vivamus fringilla mi eu lacus. * Donec eget arcu bibendum nunc consequat lobortis. - Nulla porttitor vulputate libero. . Fusce euismod commodo velit. . Vivamus fringilla mi eu lacus. .. Fusce euismod commodo velit. .. Vivamus fringilla mi eu lacus. . Donec eget arcu bibendum nunc consequat lobortis. - Praesent eget purus quis magna eleifend eleifend. 1. Fusce euismod commodo velit. a. Fusce euismod commodo velit. b. Vivamus fringilla mi eu lacus. c. Donec eget arcu bibendum nunc consequat lobortis. 2. Vivamus fringilla mi eu lacus. 3. Donec eget arcu bibendum nunc consequat lobortis. 4. Nam fermentum mattis ante. ვერტიკალური მარკირებული სია ~~~~~~~~~~~~~~~~~~~~~~~~~~~ მარკირებული სია შედგება ერთი ან რამდენიმე ტექსტური მარკერისაგან, რომელსაც მოსდევს განმარტების ტექსტი. მარკერი აუცილებლად უნდა იწყებოდეს ასოთი ან ციფრით, წინ არ უნდა ჰქონდეს პრობელები და უნდა მთავრდებოდეს ორმაგი ორწერტილით `::` ან ორმაგი წერტილ-მძიმით `;;`. განმარტების ტექსტი შედგება ერთი ან რამდენიმე ტექსტური ხაზისაგან, იწყება განმარტების უშუალოდ მომდევნო ხაზზე და შეიძლება შეიცავდეს ჩადგმულ სიას ან <>. დასაშვებია ტექსტის გამოწევა მარჯვნივ პრობელებით. აი რამდენიმე მაგალითი: --------------------------------------------------------------------- Lorem:: Fusce euismod commodo velit. Fusce euismod commodo velit. Ipsum:: Vivamus fringilla mi eu lacus. * Vivamus fringilla mi eu lacus. * Donec eget arcu bibendum nunc consequat lobortis. Dolor:: Donec eget arcu bibendum nunc consequat lobortis. Suspendisse;; A massa id sem aliquam auctor. Morbi;; Pretium nulla vel lorem. In;; Dictum mauris in urna. --------------------------------------------------------------------- შედეგი: Lorem:: Fusce euismod commodo velit. Fusce euismod commodo velit. Ipsum:: Vivamus fringilla mi eu lacus. * Vivamus fringilla mi eu lacus. * Donec eget arcu bibendum nunc consequat lobortis. Dolor:: Donec eget arcu bibendum nunc consequat lobortis. Suspendisse;; A massa id sem aliquam auctor. Morbi;; Pretium nulla vel lorem. In;; Dictum mauris in urna. ჰორიზონტალური მარკირებული სია ~~~~~~~~~~~~~~~~~~~~~~~~~~~ ჰორიზონტალური მარკირებული სია ვერტიკალურისაგან იმით განსხვავდება, რომ მარკერი და განმარტების ტექსტი ჩნდება გვერდიგვერდ, და არა ერთი მეორის ქვეშ. ჰორიზონტალური მარკირებული სიის შესაქმნელად მას უნდა მივუთითოთ სტილი \[horizontal]: --------------------------------------------------------------------- [horizontal] *Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. Fusce euismod commodo velit. *Ipsum*:: Vivamus fringilla mi eu lacus. - Vivamus fringilla mi eu lacus. - Donec eget arcu bibendum nunc consequat lobortis. *Dolor*:: - Vivamus fringilla mi eu lacus. - Donec eget arcu bibendum nunc consequat lobortis. --------------------------------------------------------------------- შედეგი: [horizontal] *Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est labitur dolorum an. Est ne magna primis adolescens. Fusce euismod commodo velit. *Ipsum*:: Vivamus fringilla mi eu lacus. - Vivamus fringilla mi eu lacus. - Donec eget arcu bibendum nunc consequat lobortis. *Dolor*:: - Vivamus fringilla mi eu lacus. - Donec eget arcu bibendum nunc consequat lobortis. [[X15]] სიის გაგრძელების ნიშანი ~~~~~~~~~~~~~~~~~~~~~ იმისათვის, რომ შემდგომი ბლოკი მოთავსდეს სიაში, იგი უნდა გამოვყოთ სიის ელემენტისაგან ერთი სტრიქონით, რომელშიც ერთადერთი პლიუსის ნიშანია. ასე შეიძლება რამდენიმე ბლოკის გადაჯაჭვება და სიის ელემენტში მოქცევა. მაგალითად: --------------------------------------------------------------------- 1. List item one. + List item one continued with a second paragraph followed by an Indented block. + ................. $ ls *.sh $ mv *.sh ~/tmp ................. + List item one continued with a third paragraph. 2. List item two. List item two literal paragraph (no continuation required). - Nested list (item one). Nested list literal paragraph (no continuation required). + Nested list appended list item one paragraph - Nested list item two. --------------------------------------------------------------------- შედეგი: 1. List item one. + List item one continued with a second paragraph followed by a Listing block. + ................. $ ls *.sh $ mv *.sh ~/tmp ................. + List item one continued with a third paragraph. 2. List item two. List item two literal paragraph (no continuation required). - Nested list (item one). Nested list literal paragraph (no continuation required). + Nested list appended list item one paragraph - Nested list item two. [[X29]] სიის ბლოკი ~~~~~~~~~~ სიის ბლოკი გამოიიყენება სიის ცხადი სახით წარმოსადგენად. იგი გამოიყოფა ზემოდან და ქვემოდან ერთი სტრიქონით, რომეიშიც ორი მინუსის ნიშანია: ----------------------------------------------- -- (სიის ბლოკი) -- ----------------------------------------------- მაგალითი: --------------------------------------------------------------------- 1. List item one. + List item one continued with a second paragraph followed by an Indented block. + ................. $ ls *.sh $ mv *.sh ~/tmp ................. + List item continued with a third paragraph. 2. List item two continued with an open block. + -- This paragraph is part of the preceding list item. a. This list is nested and does not require explicit item continuation. + This paragraph is part of the preceding list item. b. List item b. This paragraph belongs to item one of the outer list. -- --------------------------------------------------------------------- შედეგი: 1. List item one. + List item one continued with a second paragraph followed by an Indented block. + ................. $ ls *.sh $ mv *.sh ~/tmp ................. + List item continued with a third paragraph. 2. List item two continued with an open block. + -- This paragraph is part of the preceding list item. a. This list is nested and does not require explicit item continuation. + This paragraph is part of the preceding list item. b. List item b. This paragraph belongs to item one of the outer list. -- მაკროსები -------- მაკროსი არის პარამეტრიზებული ტექსტის გენერაციის მექანიზმი. ხაზში მოთავსებული მაკროსები ~~~~~~~~~~~~~~~~~~~~~~~~~~~ არსებობს სამი ტიპის მაკროსი: 'URL', 'image' და 'link' URL ^^^ სტანდარტული პრეფიქსები http, https, ftp, file, mailto და callto გვაძლევს შესაბამის შედეგს. თვით ბმულს უნდა მოსდევდეს აღწერა, მოქცეული კვადრატულ ფრჩხილებში, ან ფრჩხილების ცარიელი წყვილი, თუ აღწერა არ არის საჭრო. მაგალითად: ---------------------- http://www.methods.co.nz/asciidoc/[AsciiDoc -- საწყისი გვერდი] mailto:joe.bloggs@foobar.com[email Joe Bloggs] mailto:joe.bloggs@foobar.com[] callto:joe.bloggs[] ---------------------- შედეგი: http://www.methods.co.nz/asciidoc/[AsciiDoc -- საწყისი გვერდი] mailto:joe.bloggs@foobar.com[email Joe Bloggs] mailto:joe.bloggs@foobar.com[] callto:joe.bloggs[] TIP: თუ ბმული შეიცავს პრობელებს, ისინი შეცვლილი უნდა იყოს `%20` ნიშნით. მაგალითად `large%20image.png`. შიდა ბმულები ^^^^^^^^^^^^ [[X30]] ღუზა ++++++ ბმულის მიზნების მისათითებლად გამოიყენება (სადაც უნდა მოხდეს გადამისამართება): [[id,xreflabel]] სადაც `id` არის უნიკალური იდენტიფიკატორი, რომელიც უნდა იწყებოდეს ასოთი. `xreflabel` არის ტექსტი, რომელიც უნდა გამოჩნდეს შესაბამის ბმულში, თუ სხვა ტექსტი მითითებული არ არის. იგი აუცილებელი არ არის. მაგალითი: ---------------------- [[X1]] [[X2,საფუძვლები]] ---------------------- ბმული ++++++ ქმნის ბმულს ღუზაზე დოკუმენტის შიგნით. <> `id` არის არსებული ღუზა. არააუცილებელი `caption` არის წარწერა, რომელიც უნდა გამოჩნდეს დოკუმენტში. მაგალითი: ---------------------- <> ---------------------- ბმულები ლოკალურ დოკუმენტებზე ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 'link' მაკროსის მეშვეობით ადგილობრივ დოკუმენტზე ბმულის შექმნა ხდება. link:[] მაგალით: ---------------------- link:downloads/foo.zip[ჩამოტვირთეთ foo.zip] ---------------------- შეიძლება `#` სინტაქსის გამოყენება ადგილობრივი დოკუმენტის შიგნით ღუზაზე მიმართვისათვის. [[X9]] სურათები ^^^^^^^^ სურათის ჩასმის სინტაქსია: image:[] სადაც `` არის ფაილის სახელი. [[X55]] .ატრიბუტები - უსახელო პირველი ატრიბუტი მიუთითებს ალტერნატიულ ტექსტს, რომელიც ჩნდება თუ სურათის ჩატვირთვა შეუძლებელია. მაგალითად: + image:images/logo.png[Company Logo] - `width` და `height` ატრიბუტები შეიძლება იყოს გამოყენებული ზომების განსაზღვრისათვის: + image:images/logo.png["Company Logo",height=32] - `link` ატრიბუტი გამოიყენება სურათისაგან ბმულის გასაკეთებლად: image:screen-thumbnail.png[height=32,link="screen.png"] TIP: ჩვენს შემთხვევაში სურათებს წინ უნდა უსწრებდეს `../images/` ბლოკის მაკროსები ~~~~~~~~~~~~~~~~ ბლოკის მაკროსები იგივე როლს ასრულებს, რაც ხაზში მოთავსებული მაკროსები. ისინი წარმოდგენილი უნდა იყოს ცალკე ხაზად, ზემოდან და ქვემოდან გამოყოფილი ცარიელი ხაზებით. ხაზში მოთავსებული მაკროსებისაგან განსხვავებები: - წარმოდგენილია ბლოკის სახით. - სინტაქსი აქვს შემდეგნაირი `::[]` (ორი ორწერტილი ერთის მაგივრად). [[X49]] სურათები ^^^^^^^^ სინტაქსი: image::[] შეიძლება წინ უსწრებდეს სათაური ბლოკის_სათაურის სახით (სათაურს წინ უნდა უსწერებდეს წერტილის ნიშანი) მაგალითი: ---------------------- .სურათის სათაური image::images/layout.png[] ---------------------- შედეგში სათაურის წინ ჩნდება `Figure :` პრეფიქსი. ამისი შეცვლა შეიძლება `caption` ატრიბუტის მეშვეობით. მაგალითი: ---------------------- .სურათის სათაური [caption="სურათი 2:"] image::images/layout.png[] ---------------------- [[X25]] კომენტარის ხაზები ^^^^^^^^^^^^^^^^^ მაგალითი: // This is a comment. იხ. აგრეთვე <>. ცხრილები -------- ცხრილების შექმნა მოყვანილია მაგალიტების სახით. ჩვეულებრივი ცხრილი: --------------------------------------------------------------------- |======== |1 |2 |3 |4 |5 |6 |======== --------------------------------------------------------------------- შედეგი: |======== |1 |2 |3 |4 |5 |6 |======== ცხრილი სათაურით, ჰედერით და ფუტერით: --------------------------------------------------------------------- .ცხრილის მაგალითი [width="50%",cols=">s,^2m,^2e",frame="none",options="header,footer"] |========================== | |Column 2|Column 3 |1 |Item 1 |Item 1 |2 |Item 2 |Item 2 |3 |Item 3 |Item 3 |4 |Item 4 |Item 4 |footer 1|footer 2|footer 3 |========================== --------------------------------------------------------------------- შედეგი: .ცხრილის მაგალითი [width="50%",cols=">s,^2m,^2e",frame="none",options="header,footer"] |========================== | |Column 2|Column 3 |1 |Item 1 |Item 1 |2 |Item 2 |Item 2 |3 |Item 3 |Item 3 |4 |Item 4 |Item 4 |footer 1|footer 2|footer 3 |========================== ცხრილი, რომელიც მონაცემებს იღებს CSV ფაილიდან: --------------------------------------------------------------------- [format="csv",cols="^1,4*2",options="header"] |=================================================== ID,Customer Name,Contact Name,Customer Address,Phone include::customers.csv[] |=================================================== ---------------------------------------------------------------------