YaST2 Developers Documentation: Unknown YCP Module

Unknown YCP Module

This module has an unstable interface.

Global Functions

Info:

File: modules/HTML.ycp Package: yast2 Summary: Generic HTML formatting Authors: Stefan Hundhammer Flags: Stable

$Id$

Note: Inline doc uses [tag]...[/tag] instead of ... to avoid confusing "ycpdoc".

global Para (string text) -> string

Make a HTML paragraph from a text

i.e. embed a text into * [p]...[/p]

Parameters:
text plain text or HTML fragment
Return value:
HTML code
global Heading (string text) -> string

Make a HTML heading from a text

i.e. embed a text into [h3]...[/h3]

Note: There is only one heading level here since we don't have any more fonts anyway.

Parameters:
text plain text or HTML fragment
Return value:
HTML code
global Link (string text, string link_id) -> string

Make a HTML link

For example [a href="..."]...[/a]

You still need to embed that into a paragraph or heading etc.!

Parameters:
text (translated) text the user will see
link_id internal ID of that link returned by UserInput()
Return value:
HTML code
global ListStart () -> string

Start a HTML (unsorted) list

For example [ul]

You might consider using HTML::list() instead which takes a list of items and does all the rest by itself.

Return value:
HTML code
global ListEnd () -> string

End a HTML (unsorted) list

For example [/ul]

You might consider using HTML::list() instead which takes a list of items and does all the rest by itself.

Return value:
HTML code
global ListItem (string text) -> string

Make a HTML list item

For example embed a text into [li][p]...[/p][/li]

You might consider using HTML::list() instead which takes a list of items and does all the rest by itself.

Parameters:
text plain text or HTML fragment
Return value:
HTML code
global List (list<string> items) -> string

Make a HTML (unsorted) list from a list of strings

[ul] [li]...[/li] [li]...[/li] ... [/ul]

Parameters:
items list of strings for items
Return value:
HTML code
global ColoredList (list<string> items, string color) -> string

Make a HTML (unsorted) colored list from a list of strings

[ul] [li][font color="..."]...[/font][/li] [li][font color="..."]...[/font][/li] ... [/ul]

Parameters:
items list of strings for items
color item color
Return value:
HTML code
global Colorize (string text, string color) -> string

Colorize a piece of HTML code

i.e. embed it into [font color="..."]...[/font]

You still need to embed that into a paragraph or heading etc.!

Parameters:
text text to colorize
color item color
Return value:
HTML code
global Bold (string text) -> string

Make a piece of HTML code bold

i.e. embed it into [b]...[/b]

You still need to embed that into a paragraph or heading etc.!

Parameters:
text text to make bold
Return value:
HTML code
global Newline () -> string

Make a forced HTML line break

Return value:
HTML code
global Newlines (integer count) -> string

Make a number of forced HTML line breaks

Parameters:
count how many of them
Return value:
HTML code