Txt2tags: відмінності між версіями
Вилучено вміст Додано вміст
Bunyk (обговорення | внесок) Немає опису редагування |
Bunyk (обговорення | внесок) Немає опису редагування |
||
Рядок 1:
Документ описує систему швидкого створення документації для наступного її друку, чи публікації в інтернеті. Система чудово підійде для створення документації для програм, створення простих статичних веб-сайтів, створення контенту для складних динамічних веб-сайтів (блогів, чи вікі наприклад), швидкого запису конспектів на лекціях, чи ведення звичайних нотаток.
==
Далі буде трохи філософських роздумів про створення документації. Ви можете їх пропустити і [#whytxt2tags перейти одразу до справи].
===
Перше питання яке може виникнути: А нащо взагалі писати конспекти в електронному форматі? Всі вже звикли до нормальних. А й справді, навіщо було винаходити друкарську машинку, коли вже були ручки, і навіщо нам текстові редактори коли є друкарські машинки?
Електронний текст має купу переваг над паперовим - можливість створення безлічі копій, можливість виправлення без створення нової копії, та навіть швидкість створення (освоюйте десятипальцевий набір!).
===
Є два підходи до створення документів - ми редагуємо їх як бачимо, змінюючи шрифти, кольори, поля і т.д. або ми пишемо якийсь код, який потім перетворюється в щось придатне для друку. Чому варто обрати саме код?
Рядок 23 ⟶ 21:
І загалом, я вважаю, що вчити системи керування версіями треба ще в школі, на уроках інформатики. Мене досі ніхто не навчив, про що я сильно жалію, але це окрема історія.
===
Шедевр - це коли вже немає чого додати, ані викинути. Документи можна вважати гарно оформленими, якщо вони відповідають хоча б таким вимогам:
Рядок 32 ⟶ 30:
* Форматування документа прискорює пошук потрібної інформації, дозволяючи очам швидко виділяти головне.
===
* Вивчіть десятипальцевий спосіб набору.
* Переключайте розкладки клавішею <tt>Caps Lock</tt> (так в кілька разів швидше). І крім того, ТАК <tt>CAPS LOCK</tt> ВИКОРИСТОВУЮТЬ ТІЛЬКИ БЛОНДИНКИ В АНЕКДОТАХ ПРО ICQ. :) Правильні люди використовують мало великих букв, і їм досить клавіші <tt>Shift</tt>. Можна протестувати що це незвично, але ви спробуйте хоча б день, і вас почнуть бісити комп'ютери, які переключають розкладку інакше.
Рядок 38 ⟶ 36:
* Використовуйте хорошу мову розмітки :)
===
Скільки ви знаєте мов розмітки? Як люди що користуються інтернетом, всі мали б хоч трохи знати HTML. Як люди близькі до науки - LaTeX. Ці мови універсальні, розширювані, і взагалі чудові. Та не ідеальні. HTML потребує написання багатьох зайвих букв, таких як наприклад теги <tt><p></p></tt> біля абзаців, чи ще гірше <tt><strong></tt> для жирного тексту. LaTeX трохи кращий, та все ж теж потребує багато писанини. Наприклад для жирного тексту треба написати <tt>\textbf{жирний текст}</tt>.
Мова розмітки вікіпедії запозичила краще з обох згаданих мов, і навіть додала щось своє. Наприклад, <tt>'''жирний текст'''</tt> в вікі виділяється трьома апострофами. Абзаци розділяються порожнім рядком. Таблиці - невже може бути щось простіше? (Як виявилось може). Математичні формули вводяться в синтаксисі LaTeX (<tt>\int_a^b</tt>), та щоб позначити формулу використовують незручний тег <tt>
Одним словом, мов багато, парсерів теж багато, але кожна з них має певні недоліки. txt2tags старається від цих недоліків позбавитись. txt2tags - це як Есперанто світу мов розмітки. Щоправда не така потужна, але зате більш проста.
Рядок 70 ⟶ 68:
Думаю вже досить розказувати про те, яка ця штука зручна та корисна. Напевне вже пора пояснити як цим користуються.
==
Перед тим як вивчати якусь програму, треба її дістати.
===
====
Виконайте команду
Рядок 82 ⟶ 80:
Готово.
====
# Скачайте архів з програмою. ([http://txt2tags.sourceforge.net/download.html txt2tags.sf.net])
# Розпакуйте цей архів.
Рядок 88 ⟶ 86:
# Перемістіть його в одну з директорій що містяться у системній змінній <tt>$PATH</tt> (<tt>/usr/local/bin</tt>) Тепер txt2tags можна напряму викликати з консолі.
===
# Скачайте та встановіть Python. ([http://www.python.org/download www.python.org])
# Скачайте архів з програмою. ([http://txt2tags.sourceforge.net/download.html txt2tags.sf.net])
Рядок 100 ⟶ 98:
# Версія програми що взагалі не потребує Python для запуску (вона має вбудований)
===
Архів окрім самої програми містить документацію і ще деякі корисні файли. Зокрема підсвідку синтаксису для Vim:
Рядок 130 ⟶ 128:
При натисканні клавіші <tt>2</tt>, і одразу після неї h документ буде перетворено в html і відкрито для перегляду в браузері chromium. Якщо ваш браузер інший - змініть <tt>chromium-browser</tt> на команду що запускає ваш браузер. Для інших документів аналогічно...
===
====
# Знайдіть в архіві з програмою файл <tt>/po/uk.po</tt>, для української, чи якийсь інший для іншої мови.
# Скомпілюйте файл <tt>.po</tt> в файл <tt>.mo</tt> командою:
Рядок 143 ⟶ 141:
# Якщо програма чомуль не локалізувалась - розберіться зі своєю локаллю. [http://www.linux.org.ua/cgi-bin/twiki/view/Locale/LocalizationTechnology Детальна теорія тут]
====
# Знайдіть в архіві з програмою файл <tt>/po/README</tt> та дотримуйтесь інструкцій в ньому. Успіхів!
# Якщо у вас щось вийде - поділіться досвідом.
==
===
Графічний інтерфейс - те що ви побачите запустивши цю програму з віконного менеджера:
Рядок 155 ⟶ 153:
Загалом - графічний інтерфейс говорить сам за себе, і пояснювати тут щось - зайве. Єдине що відрізняє його від консольного - менша кількість опцій, і одна не присутня в консольному - показати результат роботи на екрані не створюючи файл (Хоча, якщо в консольній команді ви задасте "-" замість вихідного файлу, то результат теж потрапить на екран).
===
Цей інтерфейс, на відміну від інших дає доступ до всіх можливостей та налаштувань програми.
Рядок 163 ⟶ 161:
|}
===
Перевагою веб-інтерфейсу є те, що він завжди є, не залежно від того, чи встановлений txt2tags на вашому комп'ютері. [http://txt2tags.sourceforge.net/online.php Його можна знайти тут].
Вам потрібно лише скопіювати потрібний текст в поле редактора, вибрати у що конвертувати, і натиснути кнопку "Convert!". Результат покажуть знизу. І якщо це html, то навіть відобразять те як він має виглядати.
==
Краще починати практикуватись з програмою через веб-інтерфейс, або графічний інтерфейс. Там настройок набагато менше, і заплутатись важче.
Рядок 175 ⟶ 173:
Чи прочитати шпаргалку і подальші пояснення.
===
{| align="center" border="1" cellpadding="4"
|-
Рядок 209 ⟶ 207:
|}
===
Заголовки - це перші три рядки документа. Щоб відмовитись від заголовків взагалі - залиште перший рядок порожнім. Тоді основну частину документа можна починати одразу з другого рядка. Щоб відмовитись від деякої частини заголовка - залиште порожнім відповідний їй рядок (другий чи третій). Розмітка всередині тексту заголовків не працює.
Рядок 218 ⟶ 216:
# Дату створення документу та/або версію (чудове місце для <tt>%%mtime</tt> ''([#macros див. макроси])'' )
===
Абзаци - це блоки тексту що розділяються порожнім рядком, чи іншим блоком: списком, цитатою, таблицею...
Рядок 233 ⟶ 231:
</blockquote>
===
Заголовки розділів виділяються однаковою кількістю знаків дорівнює чи плюс (для нумерованих розділів) по краях.
Рядок 252 ⟶ 250:
Ім'я мітки може складатись лише з латинських букв, цифр, та символу підкреслювання "_".
===
Будь-який коректний url, чи адреса електронної пошти буде автоматично розпізнана та перетворена на гіперпосилання. Протокол писати не обов'язково, можна наприклад так: [http://www.bunyk.wordpress.com www.bunyk.wordpress.com]. Щоправда так: bunyk.wordpress.com, вже ні. Видно він визначає url за буквами www.
Рядок 261 ⟶ 259:
Якщо вихідний документ не підтримує гіперпосилання, вони лише підкреслюються.
===
Довгі масиви простого тексту швидко стомлюють людей, і їхня увага зменшується. Щоб читачі не пропустили щось важливе, текст '''виділяють'''. Виділяти текст можна різними способами, придумавши для кожного способу своє призначення. Наприклад у деяких підручниках нові терміни позначають ''курсивом''. Викреслення може привертати увагу до чогось, що не варто робити: <s><tt>$ sudo rm -rf /</tt></s>. Людям подобається заборонене, тому <s>викреслюйте текст, якщо хочете щоб на нього справді звернули увагу</s> (<u>жартую</u>).
Рядок 275 ⟶ 273:
А ще ''стилі <u>виділення</u> '''можна''' змішувати''. <tt>Ось так //стилі __виділення__ **можна** змішувати//.</tt>
===
Коментарі дають змогу написати щось у документі який ми редагуємо, що не попаде в вихідний документ.
Це можна використовувати в різних цілях. Наприклад видалити текст, який нам жаль видаляти остаточно. Є два види коментарів:
Рядок 298 ⟶ 296:
</pre>
===
* Список задається рядком що починається з мінуса, плюса чи двокрапки, після яких стоїть рівно один пропуск.
* Першим символом списку не може бути пропуск
Рядок 319 ⟶ 317:
: що заголовки списку означень не стають жирними автоматично, і це треба робити вручну. Не знав. Може тому що найчастіше користувався таким в основному в вікі.
====
Рядок що починається з труби "<tt>|</tt>" означає рядок таблиці. Якщо він починається з двох труб "<tt>||</tt>", то це рядок заголовка.
Рядок 365 ⟶ 363:
Звісно бракує способу зробити клітинку що об'єднує кілька рядків, та британські вчені довели, що 80% їх взагалі не використовують, а у 95% випадків можна обійтись і без цього.
===
Деякий текст прийнято оформляти моноширинним шрифтом. Зазвичай це текст, який користувач має набрати, комбінації клавіш, адреси та імена файлів, текст що комп'ютер виводить на термінал, чи код програм. Його виділяють символами "<tt>`</tt>", двома, якщо <tt>``такий текст``</tt> має бути в тексті рядка, трьома,
Рядок 381 ⟶ 379:
|}
===
Щоб в документі з'явилась горизонтальна лінія, потрібно ввести рядок з мінусів чи підкреслювань. Щоб з'явилась товста горизонтальна лінія треба ввести рядок з знаків рівності. Цих знаків має бути не менше двадцяти. На початку і в кінці такого рядка можуть бути пропуски. При появі інших символів рядок не буде розпізнаватись як горизонтальний.
Рядок 389 ⟶ 387:
* Розрив сторінки в документах зі сторінками, наприклад LaTeX
===
Зображення розміщуються дуже просто: <tt>[ім'я зображення.jpg]</tt>. Де замість імені зображення підставляємо шлях до нього. Розширення файлу вписувати обов'язково.
Рядок 400 ⟶ 398:
Ну, а справа - логічно справа: [[Image:./t2tpowered-white.png|right]]
===
Іноді розмітка трохи заважає. От хочете ви написати текст в //подвійних косих рисках//, а він падлюка стає курсивом. Що робити? Треба позначити текст як чистий, тобто такий, в якому символи розмітки зовсім не позначають розмітку. Виділяють "чистий" текст за допомогою двох подвійних лапок (таких: "), як це робили з коментарями, чи машинописним текстом. Є три способи: прямо в тексті, один рядок, чи багато рядків.
Чесно кажучи, це позначення не доведеться часто використовувати, оскільки на відміну від, скажімо, LaTeX символи розмітки стають такими лише за певних жорстко визначених умов, і випадково == якесь слово == заголовком, чи чимось іншим не стане. От де вимкнення розмітки справді часто застосовується - так це при написанні інструкцій з txt2tags. Повірте, я знаю :).
==
Ось така от простенька мова. На перший погляд... Хоча з іншого боку, її простота вимушена - потрібно ж якось реалізовувати сумістність з купою інших, в які відбувається трансляція.
Рядок 437 ⟶ 435:
* Всі макроси крім <tt>%%toc</tt> можуть розміщуватись будь-де в рядку. <tt>%%toc</tt> працює лише коли є єдиним в рядку.
===
Макрос <tt>%%date</tt> замінюється на дату та час генерації. Час останньої зміни задається макросом <tt>%%mtime</tt>. Обидва макроси поводяться однаково, і приймають однаковий рядок формату.
Рядок 467 ⟶ 465:
|}
===
Теги <tt>%%infile</tt> та <tt>%%outfile</tt> дозволяють дізнатись про розташування файлу з кодом, та файлу що генерується відповідно.
Рядок 491 ⟶ 489:
|}
===
Макрос <tt>%%toc</tt> вказує розмішення змісту документа. Він використовується разом з опцією командного рядка <tt>--toc</tt>, інакше ігнорується. Хоча його використання не обов'язкове, зміст автоматично розміщується на початку документа, проте з ним, зміст можна помістити будь-де в тілі документа, і скільки завгодно разів. Наприклад на початку та в кінці. Не приймає ніяких параметрів.
==
В t2t документа є ще одна частина, яку ми досі не згадували. Це область налаштувань. Міститься вона рівно між тілом документа та заголовками. Тіло документа починається там, де зустрічається перший непорожній та незакоментований рядок тексту. Ось загальна схема документа:
Рядок 509 ⟶ 507:
Не згадували ми її тому, що документ може бути і без неї, але її використання іноді досить сильно спрощує життя.
==
# Офіційний сайт: [http://txt2tags.sf.net/]
# Блог: [http://txt2tags.wordpress.com/]
| |||