Documentation

display_impr_text_text.php

\file \brief Display an improved annotated text (text frame)

Call: display_impr_text_text.php?text=[textid]

PHP version 8.1

Tags
author

LWT Project lwt-project@hotmail.com

license

Unlicense http://unlicense.org/

link
https://hugofara.github.io/lwt/docs/php/files/display-impr-text-text.html
since
1.5.0

Table of Contents

Functions

get_annotated_text()  : string
Return the annotatino of a text.
get_display_impr_text_text_data()  : array{0: int, 1: bool}
Get settings for this text.
do_diplay_impr_text_text_js()  : void
Prepare JavaScript interactions for the text content.
do_diplay_impr_text_text_area()  : void
Make the main content for a printed text.
get_word_annotations()  : array{0: string, 1: string}
Parse the annotations (translation/romanization) and return them.
do_display_impr_text_text_word()  : void
Display a single word item.
do_display_impr_text_text_main()  : void
Main function to do a complete printed text text content.

Functions

get_annotated_text()

Return the annotatino of a text.

get_annotated_text(int $textid) : string
Parameters
$textid : int

Text ID

Return values
string

Text annotations

get_display_impr_text_text_data()

Get settings for this text.

get_display_impr_text_text_data(int $textid) : array{0: int, 1: bool}
Parameters
$textid : int

Text ID

Return values
array{0: int, 1: bool}

Text size, and if this text is rigth-to-left.

do_diplay_impr_text_text_js()

Prepare JavaScript interactions for the text content.

do_diplay_impr_text_text_js() : void

do_diplay_impr_text_text_area()

Make the main content for a printed text.

do_diplay_impr_text_text_area(string $ann, string $textsize, bool $rtlScript) : void
Parameters
$ann : string

Annotations separated b tabulations "\t"

$textsize : string

Text size

$rtlScript : bool

True if this text is right-to-left

get_word_annotations()

Parse the annotations (translation/romanization) and return them.

get_word_annotations(array<string|int, string> $vals) : array{0: string, 1: string}
Parameters
$vals : array<string|int, string>

Annotations values

Tags
global

string $tbpref Database table prefix.

Return values
array{0: string, 1: string}

Translation and romanization.

do_display_impr_text_text_word()

Display a single word item.

do_display_impr_text_text_word(string $item, string $textsize) : void
Parameters
$item : string

Word item, values separated by a tabulation.

$textsize : string

Text size

do_display_impr_text_text_main()

Main function to do a complete printed text text content.

do_display_impr_text_text_main([int|null $textid = null ]) : void
Parameters
$textid : int|null = null

Text ID, we will use page request if not provided.


        
On this page

Search results