Ultraschall API functions

4.00 - "Aphrodite's Child - Four Horsemen" - 11th of February 2020 - Build: 43006

Functions Reference

Helper functions
Docs_ConvertPlainTextToHTML

Ultraschall DocML
Docs_GetAllUSDocBlocsFromString	Docs_GetUSDocBloc_ChapterContext	Docs_GetUSDocBloc_Description	Docs_GetUSDocBloc_Functioncall
Docs_GetUSDocBloc_NextChapter	Docs_GetUSDocBloc_Params	Docs_GetUSDocBloc_PreviousChapter	Docs_GetUSDocBloc_Requires
Docs_GetUSDocBloc_Retvals	Docs_GetUSDocBloc_Slug	Docs_GetUSDocBloc_SourceDocument	Docs_GetUSDocBloc_Tags
Docs_GetUSDocBloc_TargetDocument	Docs_GetUSDocBloc_Title	Docs_RemoveIndent

Docs_ConvertPlainTextToHTML

Functioncall:

string html_text = ultraschall.Docs_ConvertPlainTextToHTML(string String)

Description:
Converts a plaintext into HTML.

Converts newlines to
, Double Spaces to and Tabs to
returns nil in case of an error

Returnvalues:
string html_text the html-version of the text

Parameters:
string text the text, which shall be converted to html

Docs_RemoveIndent

Functioncall:

string unindented_text = ultraschall.Docs_RemoveIndent(string String, string indenttype)

Description:
unindents an indented text from a US_DocBloc.

There are different styles of unindentation:
  as_typed - keeps the text, as it is
  minus_starts_line - will throw away everything from start of the line until(and including) the firt - in it
  preceding_spaces - will remove all spaces/tabs in the beginning of each line
  default - will take the indentation of the first line and apply it to each of the following lines
            that means, indentation relative to the first line is kept

returns nil in case of an error

Returnvalues:
string unindented_text the string, from which the indentation was removed

Parameters:
string String the string, which shall be unindented
string indenttype the type of indentation you want to remove
   as_typed - keeps the text, as it is
   minus_starts_line - will throw away everything from start of the line until(and including) the first - in it
   preceding_spaces - will remove all spaces/tabs in the beginning of each line
   default - will take the indentation of the first line and apply it to each of the following lines
That means, indentation relative to the first line is kept.

Docs_GetAllUSDocBlocsFromString

Functioncall:

integer found_usdocblocs, array all_found_usdocblocs = ultraschall.Docs_GetAllUSDocBlocsFromString(string String)

Description:
returns all US_DocBloc-elements from a string.

returns nil in case of an error

Returnvalues:
integer found_usdocblocs the number of found US_DocBlocs in the string
array all_found_usdocblocs the individual US_DocBlocs found in the string

Parameters:
string String a string, from which to retrieve the US_DocBlocs

Docs_GetUSDocBloc_Slug

Functioncall:

string slug = ultraschall.Docs_GetUSDocBloc_Slug(string String)

Description:
returns the slug from an US_DocBloc-element

returns nil in case of an error

Returnvalues:
string slug the slug, as stored in the USDocBloc

Parameters:
string String a string which hold a US_DocBloc to retrieve the slug from

Docs_GetUSDocBloc_Title

Functioncall:

string title, string spok_lang = ultraschall.Docs_GetUSDocBloc_Title(string String, integer index)

Description:
returns the title from an US_DocBloc-element.
There can be multiple titles, e.g. in multiple languages

returns nil in case of an error

Returnvalues:
string title the title, as stored in the USDocBloc
string spok_lang the language, in which the title is stored

Parameters:
string String a string which hold a US_DocBloc to retrieve the title from
integer index the index of the title to get, starting with 1 for the first title

Docs_GetUSDocBloc_Description

Functioncall:

string description, string markup_type, string markup_version, string indent, optional string language, optional string prog_lang = ultraschall.Docs_GetUSDocBloc_Description(string String, boolean unindent_description, integer index)

Description:
returns the description-text from an US_DocBloc-element.
There can be multiple descriptions, e.g. in multiple languages

It will remove automatically indentation(as requested by the description-tag of the US_DocBloc), if unindent_description==true.
If no indentation is requested by the description-tag, it will assume default(the indentation of the first line will be applied to all other lines).

returns nil in case of an error

Returnvalues:
string description the description-text found in the USDocBloc in the string
string markup_type the markup-type the description is written in
string markup_version the version of the markup-language, in which the description is written in
string indent the indentation of the text; can be either
   as_typed - keeps the text, as it is
   minus_starts_line - will throw away everything from start of the line until(and including) the first - in it
   preceding_spaces - will remove all spaces/tabs in the beginning of each line
   default - will take the indentation of the first line and apply it to each of the following lines
string language the language, in which the description is written in; "", if not set
string prog_lang the programming-language, in which the description is written in; ", if not set

Parameters:
string String a string which hold a US_DocBloc to retrieve the description from
boolean unindent_description true, will remove indentation as given in the description-tag; false, return the text as it is
integer index the index of the description to get, starting with 1 for the first description

Docs_GetUSDocBloc_TargetDocument

Functioncall:

string target_document = ultraschall.Docs_GetUSDocBloc_TargetDocument(string String)

Description:
returns the target-document from an US_DocBloc-element.
The target-document is the document, into which the converted DocBloc shall be stored into.

returns nil in case of an error

Returnvalues:
string target_document the target-document, into which the converted US_DocBloc shall be stored into

Parameters:
string String a string which hold a US_DocBloc to retrieve the target-document-entry from

Docs_GetUSDocBloc_SourceDocument

Functioncall:

string source_document = ultraschall.Docs_GetUSDocBloc_SourceDocument(string String)

Description:
returns the source-document from an US_DocBloc-element.
The source-document is the document, into which the converted DocBloc shall be stored into.

returns nil in case of an error

Returnvalues:
string source_document the source-document, into which the converted US_DocBloc shall be stored into

Parameters:
string String a string which hold a US_DocBloc to retrieve the source-document-entry from

Docs_GetUSDocBloc_ChapterContext

Functioncall:

integer count, array chapters, string spok_lang = ultraschall.Docs_GetUSDocBloc_ChapterContext(string String, integer index)

Description:
returns the chapters and subchapters, in which the US_DocBloc shall be stored into
A US_DocBloc can have multiple chapter-entries, e.g. for multiple languages.

returns nil in case of an error

Returnvalues:
integer count the number of chapters found
array chapters the chapternams as an array
string spok_lang the language of the chapters; "", if no language is given

Parameters:
string String a string which hold a US_DocBloc to retrieve the source-document-entry from
integer index the index of the chapter-entries, starting with 1 for the first

Docs_GetUSDocBloc_Tags

Functioncall:

integer count, array tags, string spok_lang = ultraschall.Docs_GetUSDocBloc_Tags(string String, integer index)

Description:
returns the tags of an US_DocBloc-entry
A US_DocBloc can have multiple tag-entries, e.g. for multiple languages.

returns nil in case of an error

Returnvalues:
integer count the number of tags found
array tags the tags as an array
string spok_lang the language of the tags; "" if no language is given

Parameters:
string String a string which hold a US_DocBloc to retrieve the tags-entry from
integer index the index of the tags-entries, starting with 1 for the first

Docs_GetUSDocBloc_Params

Functioncall:

integer parmcount, table Params, string markuptype, string markupversion, string prog_lang, string spok_lang, string indent = ultraschall.Docs_GetUSDocBloc_Params(string String, boolean unindent_description, integer index)

Description:
returns the parameters of an US_DocBloc-entry
A US_DocBloc can have multiple parameter-entries, e.g. for multiple languages.

returns nil in case of an error

Returnvalues:
integer parmcount the number of parameters found
table Params all parameters found, as an array
   Params[index][1] - parametername
   Params[index][2] - parameterdescription
string markuptype the markuptype found; if no markuptype is given, it returns "plaintext"
string markupversion the version of the markuptype found; "", if not given
string prog_lang the programming-language used in these parameters; "", if not given
string spok_lang the spoken-language used in these parameters; "", if not given
string indent the type of indentation you want to remove
   as_typed - keeps the text, as it is
   minus_starts_line - will throw away everything from start of the line until(and including) the first - in it
   preceding_spaces - will remove all spaces/tabs in the beginning of each line
   default - will take the indentation of the first line and apply it to each of the following lines
That means, indentation relative to the first line is kept.

Parameters:
string String a string which hold a US_DocBloc to retrieve the parameter-entry from
boolean unindent_description true, will remove indentation as given in the parameter-tag; false, return the text as it is
integer index the index of the parameter-entries, starting with 1 for the first

Docs_GetUSDocBloc_Retvals

Functioncall:

integer retvalscount, table retvals, string markuptype, string markupversion, string prog_lang, string spok_lang, string indent = ultraschall.Docs_GetUSDocBloc_Retvals(string String, boolean unindent_description, integer index)

Description:
returns the retvals of an US_DocBloc-entry
A US_DocBloc can have multiple retvals-entries, e.g. for multiple languages.

returns nil in case of an error

Returnvalues:
integer retvalscount the number of retvals found
array retvals all retvals found, as an array
   retvals[index][1] - retvalsname
   retvals[index][2] - retvalsdescription
string markuptype the markuptype found; if no markuptype is given, it returns "plaintext"
string markupversion the version of the markuptype found; "", if not given
string prog_lang the programming-language used in these retvals; "", if not given
string spok_lang the spoken-language used in these retvals; "", if not given
string indent the type of indentation you want to remove
   as_typed - keeps the text, as it is
   minus_starts_line - will throw away everything from start of the line until(and including) the first - in it
   preceding_spaces - will remove all spaces/tabs in the beginning of each line
   default - will take the indentation of the first line and apply it to each of the following lines
That means, indentation relative to the first line is kept.

Parameters:
string String a string which hold a US_DocBloc to retrieve the retvals-entry from
boolean unindent_description true, will remove indentation as given in the retvals-tag; false, return the text as it is
integer index the index of the retvals-entries, starting with 1 for the first

Docs_GetUSDocBloc_Functioncall

Functioncall:

string functioncall, string prog_lang = ultraschall.Docs_GetUSDocBloc_Functioncall(string String, integer index)

Description:
returns the functioncall-entries from an US_DocBloc-element

There can be multiple functioncall-entries, e.g. for multiple programming-languages

returns nil in case of an error

Returnvalues:
string functioncall the functioncall, as stored in the USDocBloc
string prog_lang the used programming language

Parameters:
string String a string which hold a US_DocBloc to retrieve the functioncall-entry from
integer index the index of the functioncall, if there are multiple ones; beginning with 1

Docs_GetUSDocBloc_Requires

Functioncall:

integer count, array requires, array requires_alt = ultraschall.Docs_GetUSDocBloc_Requires(string String)

Description:
returns the requires-entries from an US_DocBloc-element

returns nil in case of an error

Returnvalues:
integer count the number of required elements found in the require-tag
array requires the requires found; of the format element=versionnumber, e.g. "Reaper=5.978"
array requires_alt like requires, but the index is the required element, while the value is the versionnumber, e.g requires_alt["Reaper"]="5.978"

Parameters:
string String a string which hold a US_DocBloc to retrieve the requires-entry from

Docs_GetUSDocBloc_PreviousChapter

Functioncall:

string previous_chapter = ultraschall.Docs_GetUSDocBloc_PreviousChapter(string String)

Description:
returns the slug of the previous chapter of an US_DocBloc-element

returns nil in case of an error

Returnvalues:
string previous_chapter the slug of the previous-chapter, as stored in the USDocBloc

Parameters:
string String a string which hold a US_DocBloc to retrieve the slug of the previous chapter from

Docs_GetUSDocBloc_NextChapter

Functioncall:

string next_chapter = ultraschall.Docs_GetUSDocBloc_NextChapter(string String)

Description:
returns the slug of the next chapter of an US_DocBloc-element

returns nil in case of an error

Returnvalues:
string next_chapter the slug of the next-chapter, as stored in the USDocBloc

Parameters:
string String a string which hold a US_DocBloc to retrieve the slug of the next chapter from

Automatically generated by Ultraschall-API 4.00 - 1111 functions and 6 Api-variables available

Functions Engine	GFX Engine	GUI Engine	Video Engine	Audio Engine	Doc Engine
Introduction/Concepts	Concepts	Concepts	Concepts	Concepts	Concepts
Functions	Functions	Functions	Functions	Functions	Functions

integer found_usdocblocs	the number of found US_DocBlocs in the string
array all_found_usdocblocs	the individual US_DocBlocs found in the string

string title	the title, as stored in the USDocBloc
string spok_lang	the language, in which the title is stored

string String	a string which hold a US_DocBloc to retrieve the title from
integer index	the index of the title to get, starting with 1 for the first title

string description	the description-text found in the USDocBloc in the string
string markup_type	the markup-type the description is written in
string markup_version	the version of the markup-language, in which the description is written in
string indent	the indentation of the text; can be either as_typed - keeps the text, as it is minus_starts_line - will throw away everything from start of the line until(and including) the first - in it preceding_spaces - will remove all spaces/tabs in the beginning of each line default - will take the indentation of the first line and apply it to each of the following lines
string language	the language, in which the description is written in; "", if not set
string prog_lang	the programming-language, in which the description is written in; ", if not set

string String	a string which hold a US_DocBloc to retrieve the description from
boolean unindent_description	true, will remove indentation as given in the description-tag; false, return the text as it is
integer index	the index of the description to get, starting with 1 for the first description

integer count	the number of chapters found
array chapters	the chapternams as an array
string spok_lang	the language of the chapters; "", if no language is given

integer count	the number of tags found
array tags	the tags as an array
string spok_lang	the language of the tags; "" if no language is given

integer parmcount	the number of parameters found
table Params	all parameters found, as an array Params[index][1] - parametername Params[index][2] - parameterdescription
string markuptype	the markuptype found; if no markuptype is given, it returns "plaintext"
string markupversion	the version of the markuptype found; "", if not given
string prog_lang	the programming-language used in these parameters; "", if not given
string spok_lang	the spoken-language used in these parameters; "", if not given
string indent	the type of indentation you want to remove as_typed - keeps the text, as it is minus_starts_line - will throw away everything from start of the line until(and including) the first - in it preceding_spaces - will remove all spaces/tabs in the beginning of each line default - will take the indentation of the first line and apply it to each of the following lines That means, indentation relative to the first line is kept.

integer retvalscount	the number of retvals found
array retvals	all retvals found, as an array retvals[index][1] - retvalsname retvals[index][2] - retvalsdescription
string markuptype	the markuptype found; if no markuptype is given, it returns "plaintext"
string markupversion	the version of the markuptype found; "", if not given
string prog_lang	the programming-language used in these retvals; "", if not given
string spok_lang	the spoken-language used in these retvals; "", if not given
string indent	the type of indentation you want to remove as_typed - keeps the text, as it is minus_starts_line - will throw away everything from start of the line until(and including) the first - in it preceding_spaces - will remove all spaces/tabs in the beginning of each line default - will take the indentation of the first line and apply it to each of the following lines That means, indentation relative to the first line is kept.

string functioncall	the functioncall, as stored in the USDocBloc
string prog_lang	the used programming language

integer count	the number of required elements found in the require-tag
array requires	the requires found; of the format element=versionnumber, e.g. "Reaper=5.978"
array requires_alt	like requires, but the index is the required element, while the value is the versionnumber, e.g requires_alt["Reaper"]="5.978"