Sfairadora

  • Referenční příručka

encode_html

encode_html(rtxt, html_settings)
Parametr rtxt je buď Rich_string nebo Rich_text. Funkce vrátí jeho reprezentaci ve formátu HTML. Výsledkem je String obsahující výsledný kód HTML. Funkce může vrátit chybu pokud selže zapisování případných obsažených obrázků.
Parametr html_settings typu HTML_settings upřesňuje způsob konverze. Jde o strukturu s následujícími složkami:
Typ složky
Název složky
Popis
String
global_block_class
Pokud je hodnota zadána, určuje jméno třídy stylu CSS, který se přiřadí HTML elementu, který obsahuje celý výstupní text.
Výchozí hodnota je "rich_text_block".
String
image_folder
Složka, do které se budou ukládat obrázky, pokud jsou v textu obsaženy.
String
img_src_prefix
Cesta připojená před jméno souboru s obrázkem, jak bude zakódována do HTML. (Hodnota by měla odrážet umístění složky obrázků ve vztahu ke konečnému umístění výsledného souboru HTML.)
String
img_class_name
Pokud je řetězec zadán, jde o jméno třídy stylu CSS, která bude přiřazována HTML elementu s obrázkem (<img>).
Int optional
src_page_width
Šířka stránky v jednotkách twips vzhledem k níž se bere šířka obsažených obrázků.
Int optional
dest_page_width
Šířka stránky cílového dokumentu.
Pokud jsou zadány obě hodnoty src_page_width a dest_page_width, použijí se pro překódování velikostí obrázků.
Výchozí hodnoty nejsou zadány.
String
pw_unit
Jednotka, v níž je zadána hodnota dest_page_width. Musí jít o platnou jednotu CSS.
Výchozí hodnota je "px" (pixely).
Int
src_dpi
DPI výchozího textu, které se použije pro překódování velikostí obrázků, pokud nejsou zadány hodnoty src_page_width a dest_page_width.
Výchozí hodnota je 96.
Int optional
max_img_width
Maximální šířka obrázku v cílových jednotkách, která se může zakódovat do HTML. Pokud by měl mít obrázek větší šířku, zakóduje se tato (výška se adekvátně upraví také). Obrázky s takto omezenou velikostí se kliknutím dají zobrazit v novém okně v původní velikosti.
Výchozí hodnota není zadána.
Byte
hidden_text
Způsob kódování skrytého textu (textu označeného jako hidden):
0
nekódovat
1
šedě podšrafovaný (jako je zobrazován ve Sfairadoře).
Text optional
header
Záhlaví souboru HTML až po <body> včetně tohoto elementu. Pokud není hodnota zadána, vytvoří se standardní záhlaví.
Výchozí hodnota není zadána (tj. vytváří se standardní záhlaví automaticky).
Text optional
footer
Ukončení souboru HTML komplementární k hodnotě header. Pokud hodnota není zadána, vytvoří se standardní.
Výchozí hodnota není zadána.
String
title
Pokud není zadána hodnota header, použije se tato hodnota jako titulek vytvářené stránky. Pokud hodnota header je zadána, už musí titulek obsahovat a tato hodnota ignoruje.

Viz též