Разлика между версии на „Описание на формата SFB“

От Уики на Читанка
Направо към: навигация, търсене
(от http://chitanka.info/lib/help/sfb)
 
м (изтървана единица при връзката към мнението на Мандор)
Ред 1: Ред 1:
''(Това описание е съставено въз основа на [[forumtopic:51|мнение на Мандор, пуснато във форума]].)''
+
''(Това описание е съставено въз основа на [[forumtopic:511|мнение на Мандор, пуснато във форума]].)''
  
 
Имайте предвид, че този формат описва структурата на художественото произведение, а не начина, по който се форматира и извежда. В [[chitanka:lib/sandbox|пясъчника]] можете да си правите експерименти и да видите по какъв начин се форматират текстовете в ''Моята библиотека''.
 
Имайте предвид, че този формат описва структурата на художественото произведение, а не начина, по който се форматира и извежда. В [[chitanka:lib/sandbox|пясъчника]] можете да си правите експерименти и да видите по какъв начин се форматират текстовете в ''Моята библиотека''.

Версия от 15:35, 4 октомври 2010

(Това описание е съставено въз основа на мнение на Мандор, пуснато във форума.)

Имайте предвид, че този формат описва структурата на художественото произведение, а не начина, по който се форматира и извежда. В пясъчника можете да си правите експерименти и да видите по какъв начин се форматират текстовете в Моята библиотека.

Обща информация

Текстът се форматира по правилото „един ред — един абзац“. Всеки ред започва с табулатор. В следващите примери табулаторите са представени така:

Табулатор

Форматиращите елементи (маркерите) се разполагат преди табулатора. Те се разделят на два вида: блокови и едноредови.

Блокови маркери

Ограждат част от текст с „X>“ (отварящ маркер) и „X$“ (затварящ маркер), където „X“ е кодът на маркера. Трябва да са сами на ред; без табулатор преди маркера и без текст след него. Кодовете на всички маркери са на латиница. Такива маркери са:

  • A (анотация),
  • C (цитат),
  • D (посвещение),
  • E (епиграф),
  • F (предварително форматиран текст),
  • I (информация),
  • L (писмо),
  • P (стихотворение),
  • S (табелка),
  • T (таблица),
  • M (стилове).

Едноредови маркери

Разполагат се в началото на абзаца, преди табулатора, и оказват влияние само върху този абзац. Такива маркери са:

  • | (заглавие),
  • (заглавия на секции от различни равнища):
    • >,
    • >>,
    • >>>,
    • >>>>,
    • >>>>>,
  • # (подзаглавие),
  • @ (автор),
  • ! (заглавен ред в таблица),
  • F (предварително форматиран текст),
  • S (табелка).

Заглавие

Заглавие се маркира чрез знака „|“, код 0x7C (#124). Ако заглавието е от няколко реда, всичките трябва да са маркирани с „|“:

Пример:

| Иван Ефремов | Часът на бика

Само книгата и стихотворенията могат да съдържат заглавия.

Анотация

Анотацията е кратко представяне на произведението, най-често го отпечатват на задната корица. Анотацията се огражда с двойката маркери „A>“ и „A$“ и трябва да се постави веднага след заглавието на произведението.

Пример:

A> В дълбока древност цар Калидаса изгражда Фонтаните на Рая. … A$

Секция

Секцията е самостоятелен фрагмент от текста, който може да има собствено заглавие, епиграф и т.н. При романите секция се явява отделна глава или част от произведението, а при разказите цялото произведение е една секция (в повечето случаи).

Секцията се маркира с един или повече последователни знака „>“, код 0x3E (#62). Броят на знаците показва нивото на вложеност на секцията. Ако заглавието на секцията е от няколко реда, всичките трябва да са маркирани с „>“.

Пример:

> ЧАСТ ПЪРВА > Срещу глупостта… … >> Глава 1 … >>> 1. … >>> 2. … >> Глава 2 … > ЧАСТ ВТОРА > …самите богове… … >> Глава 1 … >> Глава 2

Заглавието на секцията не е задължително, т.е. след маркера може и да няма текст (пример: „Дюн“ на Франк Хърбърт).

За по-удобно визуално възприятие се препоръчва оставянето на два празни реда преди заглавието на секцията и един празен ред след него.

Подзаглавие

Подзаглавие се маркира чрез знака „#“, код 0x23 (#35). За разлика от заглавието, подзаглавието може да се появява на произволно място в текста и не участва в съдържанието на книгата.

Пример:

На първа страница пишеше: C> # ЦЕНИТЕ СЕ ПОКАЧВАТ! Нашият кореспондент… … C$

Епиграф (мото)

Епиграфът се огражда с двойката маркери „E>“ и „E$“. Епиграф може да се появи само в началото на книгата, в началото на секция или в началото на стихотворение (след заглавията, ако ги има). Допустимо е описването на повече от един последователни епиграфа, както и смесването на епиграфи и посвещения.

Пример:

E> Homo homini lupus est. @ Латинска поговорка E$

Посвещение

Посвещението се огражда с двойката маркери „D>“ и „D$“. За разлика от епиграфа, той може да се появи само в началото на книга. Във всичко останало не се различава от епиграфа.

Пример:

D> На читателите ми. D$

Цитат

Цитатът се огражда с двойката маркери „C>“ и „C$“. Цитат може да се появява само в тялото на секция.

Пример:

На първа страница пишеше: C> # ЦЕНИТЕ СЕ ПОКАЧВАТ! Нашият кореспондент… … C$

Стихотворение

Стихотворенията се ограждат с двойката маркери „P>“ и „P$“. Те могат да имат собствено заглавие и епиграф (посвещение). Отделните куплети от поемата се разделят с празен ред.

Пример:

P> # ВРЕМЕ Текат минути, часове и дни — в безспирен бяг безследно отлетели, Как страшно в тези четири стени Ти блъскаш свойте мисли посивели…

И чакаш някого… Но идва ден … @ Пинк Флойд P$

Знак/табелка

Знаци, табели и др. подобни текстове (които обикновено се форматират като центрирани с рамка) се ограждат с двойката маркери „S>“ и „S$“.

Пример:

Пред къщата имаше табелка: S> ЗА ПРОДАН S$

Може да се използва и едноредов маркер, но не е препоръчително.

Пример:

Пред къщата имаше табелка: S ЗА ПРОДАН

Таблици

Таблици се дефинират чрез блоковия маркер „T“. За евентуално заглавие на таблицата се ползва маркерът „#“.

Заглавните редове се отбелязват чрез едноредовия маркер „!“. Клетките в реда се разделят чрез знака „|“, код 0x7C (#124).

Пример:

T> # Примерна таблица ! Колонка 1 | Колонка 2 Клетка 1.1 | Клетка 1.2 Клетка 2.1 | Клетка 2.2 T$

Като HTML горният пример би могъл да изглежда така:

Примерна таблица
Колонка 1 Колонка 2
Клетка 1.1 Клетка 1.2
Клетка 2.1 Клетка 2.2

Писмо

Писмо се огражда с двойката маркери „L>“ и „L$“.

Пример:

L> Драги ми Смехурко, Бързам да ти пиша. Но как да захвана? … … @ Твой приятел вечен: @ Весел Патиланчо L$

Автор на текст

Автор на текст се маркира със знака „@“, код 0x40 (#64). Той може да се появи в края на епиграф, цитат, стихотворение, писмо. Вижте съответните примери за тези елементи.

Предварително форматиран текст

За предварително форматиран текст се използва маркерът „F“ в ролята му на блоков или на единичен маркер.

Пример:

F> 1 1 1 1 2 1 1 3 3 1 1 4 6 4 1 1 5 10 10 5 1 F$

Информация

Допълнителната информация за произведението (сканирал, редактирал, издателство и т.н.) се записва в края на текста и се огражда чрез маркерите „I>“ и „I$“.

Пример:

I> Сканиране и разпознаване: Иван, 2007 Редакция: Петър, 2007 I$

Бележки под линия

Мястото на препратката към забележката се маркира със звездичка — „*“. Ако в един абзац има повече от една препратка, те могат да се маркират с няколко последователни звездички или със звездичка, следвана от число.

Текстът на бележката под линия трябва да се появи на следващия ред, да е ограден в квадратни скоби („[…]“) и да започва с текста на препратката. Текстът на бележката може да е от няколко реда.

Пример:

— Какъв номер, господи! Сансасионел!*1 Дьо тонер!*2 [*1 Сензационно! — бел.ред.] [*2 Гръмотевично! — бел.ред.]

Курсив и получер

Смисловото ударение върху текст се отбелязва чрез ограждането на текста със знака „_“ — код 0x5F (#95). Най-често се форматира в курсив (наклонен текст); в по-старите книги — с малко по-голяма разредка между буквите.

Пример:

— Но ние _трябва_ да отидем!

Ще се покаже като:

— Но ние трябва да отидем!

За по-голямо смислово ударение се ползват два последователни знака — „__“. Обикновено текстът се форматира в получер.

Пример:

— Но ние наистина __трябва__ да отидем!

Ще се покаже като:

— Но ние наистина трябва да отидем!

Изображения

Изображенията се дефинират чрез конструкцията {img:име-на-файл} или {img:име-на-файл|Алтернативен текст}. Във втория случай алтернативният текст се показва на читателя, ако самото изображение не може да бъде заредено или видяно. Препоръчително е изображението да е във формат JPEG или PNG. Ако конструкцията {img:…} е самичка на реда, тогава изображението се извежда центрирано на самостоятелен ред, напр:

Пример:

На листчето беше нарисувано следното: {img:listche.png|Множество разноцветни многоъгълници} — Но това е пълна бъркотия! — учуди се…

Ако около конструкцията {img:…} има текст, тогава картинката се „вмъква“ на съответното място, напр:

Пример:

…ще маркирам мястото със знака {img:znak.png}. Ще се срещнем…

Използването на формата PNG е препоръчително при изображения с малко количество цветове.

Сюжетни разделители

В повечето книги се използват два типа сюжетни разделители — три последователни звездички или празни редове.

В първия вариант звездичките се изписват в текстовата част на реда (след табулатора); пред тях няма маркер; между звездичките се оставя по един интервал. За по-добро визуално възприятие е желателно да се остави по един празен ред преди и след разделителя.

Пример:

…   * * *  

Във втория вариант се оставят два празни реда. Напоследък издателствата започват да икономисват място, като оставят само един празен ред, но това е неправилно.

Специфични знаци

За късо тире (или дефис) (например при съставни думи като „синьо-зелен“) се използва стандартният знак с код 0x2D (#45). За дълго тире (напр. в пряка реч) се използва знакът „“ с код 0x2014 (#8212). Около късото тире не трябва да има интервали; около дългото тире винаги има по един интервал (освен когато са в началото на реда). При особени случаи като „кино– и фотоапарати“ или „…достигна –15°C“ се използва средно тире с код 0x2013 (#8211).

За апостроф се използва знакът „'“ с код 0x27 (#39).

Ударението се маркира чрез знака „`“ с код 0x60 (#96), поставен след ударената гласна.

За кавички е препоръчително да се използват стандарните български кавички („…“), с кодове съответно 0x201E (#8222) за отваряща и 0x201C (#8220) за затваряща, или ъгловите (френски) кавички («…»), с кодове съответно 0xAB (#171) за отваряща и 0xBB (#187) за затваряща.

Броят на отварящите и затварящите кавички трябва да е еднакъв, дори при натрупване на две и повече последователни кавички, напр.:

На бележката пишеше: „Ще се видим в «Хилтън»“

Всички тези знаци служат като маркировка; след преобразуването (напр. в HTML) те ще се трансформират в съответните типографски знаци.

Различни стилове

Има възможност за присвояване на различни предварително дефинирани стилове към части от текста. Това става чрез блоковия маркер M или чрез вътрередовия маркер m.

Примери:

M> sujet2 Тук започва втора сюжетна линия. M$

M> center Центриран текст. M$

Интересно форматиране: {m big}по-голям шрифт{/m}, {m smallcaps}текст с главни букви{/m}, {m pink}текст в розово{/m}.

Поддържат се следните стилове:

sujet2
втора сюжетна линия
center
центиране
smallcaps
малки главни букви
underline
подчертаване
overline
надчертаване
upper
превръщане в главни букви
big
уголемяване с 10%
bigger
уголемяване с 20%
small
смаляване с 10%
smaller
смаляване с 20%