Bloxxy — dokumentace
O Bloxxy | Instalace | Tvorba šablon | Publikování | Zálohování | Import dat

BX Tags

Bloxxy používá pro snazší psaní příspěvků automatické formátování (BXTags). Jeho idea vychází z podobných existujících editorů, ale žádný nekopíruje - BXTags byly vytvořeny úplně od začátku, jen podle mých vlastních potřeb (ostatně stejně jako celé Bloxxy). Použití automatického formátování lze zcela vypnout v nastavení (v souboru bloxxy-settings.php), stejnou proměnnou se nastavuje, zda se příspěvky formátují jako HTML, nebo jako XHTML (výchozí nastavení).

BXTags primárně pracuje s odstavci. Nový odstavec určuje odřádkování, vše mezi dvěma entery (resp. začátkem/koncem textu) je jeden odstavec. Pokud není určeno jinak, odstavec se formátuje jako <p>odstavec</p>. Pouze v prípadě, kdy nový odstavec začíná znakem +, spojí se s předchozím odstavcem a + je nahrazeno značkou <br>, resp. <br /> v případě XHTML. Vše je potom zpracováváno jako jeden odstavec.

BXTags rozpoznává tři druhy formátovacích značek: celořádkové (značka na samostatném řádku), prefixy (podle prvního znaku odstavce se určí jeho formátování) a vnitřní formátování. Následuje popis jednotlivých formátovacích značek:

Celořádkové značky - odstavec obsahuje pouze:

\ ............. zastaví/spustí autoformátování
--- ........... vodorovná linka HR (tři a více pomlček)
{-- ........... začátek PRE
--} ........... konec PRE

Na první řádek za značkou tagu PRE {-- doporučuji vložit zpětné lomítko \, aby nedocházelo k formátování uvnitř tagu a pokračovat až na dalším řádku. Před ukončovací značkou tagu PRE {-- je poté nutné opět vložit zpětné lomítko pro opětovné zahájení formátování.

Jestliže vkládáte jakýkoliv předem formátovaný (X)HTML kód, doporučuji vložit před něj a za něj znak zpětného lomítka, aby nebyl formátován. Jednak to ušetří čas při generování a jednak předejdete kolízím s BX Tags, i když tyto by teoreticky nastat neměly.

Prefixy
Odstavec začíná následujícím znakem/sekvencí (kromě + musí následovat alespoň jedna mezera):

\ cokoli ...... neformátuj tento odstavec
|| cokoli ..... odstavec je komentář
||| cokoli .... odstavec se nezobrazí
+cokoli ....... odstavec se připojí k předchozímu odstavci
: cokoli ...... odstavec je nadpis H4
:: cokoli ..... odstavec je nadpis H3
::: cokoli .... odstavec je nadpis H2
:::: cokoli ... odstavec je nadpis H1
" cokoli ...... odstavec je citací BLOCKQUOTE (dovnit se vloží ještě DIV)

=class cokoli ... odstavec dané třídy (nahradí se <div class="class">)
^id cokoli ...... odstavec daného selektoru (nahradí se <div id="id">)
# cokoli ........ odstavec je položkou číslovaného seznamu OL
- cokoli ........ odstavec je položkou nečíslovaného seznamu UL
* cokoli ........ dtto
. cokoli ........ dtto

Za sebou následující položky stejného typu tvoří jeden seznam, jiný typ odstavce seznam přeruší. Vnořené seznamy proto nelze vytvořit.

Vnitřní formátování
Kdekoli uvnitř textu odstavce (za případným prefixem):

*cokoli* ...................... zesílený text (STRONG)
~cokoli~ ...................... zvýrazněný text (EM)
[text|URL], [URL] ............. odkaz (A HREF=URL)
[text|title|URL] .............. odkaz s atributem title
[?zkratka|popis], [?zkratka] .. zkratka (ABBR)
[!definice|popis] ............. definice (DFN)
[@imgURL|alttext] ............. obrázek
[@imgURL|alttext|URLnáhledu] .. obrázek s náhledem
{{"cokoli}} ................... citace (Q)
{{'cokoli}} ................... citace (CITE)
{{-cokoli}} ................... obecný textový element (SPAN)
{{_cokoli}} ................... smazaný obsah (DEL)
{{cokoli}} .................... kód (CODE)

Speciální znaky a sekvence:

\znak znak (\ ruší speciální význam následujícího znaku)
\\ .... \


& ..... ampersand & (&amp;)
_ ..... nedělitelná mezera (&nbsp;)
\> .... větší než > (&gt;)
\< .... menší než < (&lt;)
- ..... sekvence mezera-divis-mezera se nahradí 
        dlouhou pomlčkou (&nbsp;&mdash; mezera)
... ... tři tečky … (&hellip;)
(c) ... copyright © (&#xA9;)
(r) ... registred trademark ® (&#xAE;)
%% ... promile ‰ (&#x2030;)
-> ... šipka doprava → (&#x2192;)
<- ... šipka doleva ← (&#x2190;)
+- ... plus mínus ± (&#xB1;)
1/2 ... jedna polovina ½ (&#xBD;)
1/4 ... jedna čtvrtina ¼ (&#xBC;)
3/4 ... tři čtvrtiny ¾ (&#xBE;)
^a ... a (horní index) ª (&#xAA;)
^o ... stupeň ° (&#xB0;)
^1 ... na první ¹ (&#xB9;)
^2 ... na druhou ² (&#xB2;)
^3 ... na třetí ³ (&#xB3;)

Makra

Defaultně vypnuto, jejich používání je zbytečné.

S nastavením $replace_macros=true se budou překládat v příspěvcích makra. Za makro se považuje sekvence znaků mezi dvěma ^, např. ^w3^. Celá sekvence se pak nahradí řetězcem definovaným pro danou sekvenci v souboru 'bloxxy-settings.php'.

Smajlíky

Defaultně vypnuto, jejich používání je zbytečné.

S nastavením $use_smileys=true se budou v příspěvcích nahrazovat smajlíky obrázky. Textový smajlík musí být ohraničen mezerami, sousedí-li s jinými znaky, nahrazen nebude. Nastavení použitých obrázků je v souboru 'bloxxy-settings.php'. Základní instalace Bloxxy obsahuje nejčastěji používané smajlíky a pokud vám stačí, nic měnit nemusíte. Bloxxy nyní překládá tyto smajlíky:

:) :-) (:-) atd. smile
:)) :-)) :-D (:-D atd. laught
;) ;-) blink
:[ ):-[ atd. grr
:/ (:-/ hmm
:-o (:0 :-O atd. oops
:( ):-( atd. sad

Dále v tématu:

Bloxxy — dokumentace
O Bloxxy | Instalace | Tvorba šablon | Publikování | Zálohování | Import dat


Martin Šrubař, Michal Poppe © 2004 – Bloxxy
Část textů použita z původní dokumentace Petra Staníčka a Bohumíra Zámečníka