^
Docs_ConvertPlainTextToHTML
Lua: string html_text = ultraschall.Docs_ConvertPlainTextToHTML(string String, optional boolean nobsp, optional boolean ignore_pre)
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 |
| optional boolean nobsp |
| true, keep tabs and whitespaces as they are; false or nil, replace tabs with and two whitespaces in a row with two |
| optional boolean ignore_pre |
true, do not insert
between lines using and ; false or nil; always end each line with
|
^
Docs_FindReaperApiFunction_Pattern
Lua: integer found_functions_count, table found_functions, table found_functions_desc = ultraschall.Docs_FindReaperApiFunction_Pattern(string pattern, boolean case_sensitive, optional boolean include_descriptions, optional boolean include_tags)
searches for functionnames in the docs, that follow a certain searchpattern(supports Lua patternmatching).
You can also check for case-sensitivity and if you want to search descriptions and tags as well.
the returned tables found_functions is of the format:
found_functions_desc[function_index]["functionname"] - the name of the function
found_functions_desc[function_index]["description"] - the entire description
found_functions_desc[function_index]["description_snippet"] - a snippet of the description that features the found pattern with 10 characters before and after it
found_functions_desc[function_index]["desc_startoffset"] - the startoffset of the found pattern; -1 if pattern not found in description
found_functions_desc[function_index]["desc_endoffset"] - the endoffset of the found pattern; -1 if pattern not found in description
found_functions_desc[function_index]["extension"] - the extension used, like Reaper, SWS, JS, ReaImGui, Osara, etc
found_functions_desc[function_index]["extension_version"] - the version of the extension
returns -1 in case of an error
Returnvalues:
| integer found_functions_count |
| the number of found functions that follow the search-pattern |
| table found_functions |
| a table with all found functions that follow the search pattern |
| table found_functions_desc |
a table with all found matches within descriptions, including offset.
Index follows the index of found_functions |
Parameters:
| string pattern |
| the search-pattern to look for a function |
| boolean case_sensitive |
| true, search pattern is case-sensitive; false, search-pattern is case-insensitive |
| optional boolean include_descriptions |
| true, search in descriptions; false, don't search in descriptions |
| optional boolean include_tags |
| true, search in tags; false, don't search in tags |
^
Docs_FindReaperConfigVar_Pattern
Lua: integer found_configvar_count, table found_configvars, table found_config_vars_desc = ultraschall.Docs_FindReaperConfigVar_Pattern(string pattern, boolean case_sensitive, optional boolean include_descriptions, optional boolean include_tags)
searches for configvariables in the docs, that follow a certain searchpattern(supports Lua patternmatching).
You can also check for case-sensitivity and if you want to search descriptions and tags as well.
the returned table found_config_vars_desc is of the format:
found_config_vars_desc[configvar_index]["configvar"] - the name of the found config variable
found_config_vars_desc[configvar_index]["description"] - the entire description
found_config_vars_desc[configvar_index]["description_snippet"] - a snippet of the description that features the found pattern with 10 characters before and after it
found_config_vars_desc[configvar_index]["desc_startoffset"] - the startoffset of the found pattern; -1, if pattern not found in description
found_config_vars_desc[configvar_index]["desc_endoffset"] - the endoffset of the found pattern; -1, if pattern not found in description
returns -1 in case of an error
Returnvalues:
| integer found_configvar_count |
| the number of found config variables that follow the search-pattern |
| table found_configvars |
| a table with all found config variables that follow the search pattern |
| table found_config_vars_desc |
a table with all found matches within descriptions, including offset.
Index follows the index of found_functions
table will be nil if include_descriptions=false |
Parameters:
| string pattern |
| the search-pattern to look for a config variable |
| boolean case_sensitive |
| true, search pattern is case-sensitive; false, search-pattern is case-insensitive |
| optional boolean include_descriptions |
| true, search in descriptions; false, don't search in descriptions |
| optional boolean include_tags |
| true, search in tags; false, don't search in tags |
^
Docs_FindUltraschallApiFunction_Pattern
Lua: integer found_functions_count, table found_functions, table found_functions_desc = ultraschall.Docs_FindUltraschallApiFunction_Pattern(string pattern, boolean case_sensitive, optional boolean include_descriptions, optional boolean include_tags)
searches for Ultraschall-API functionnames in the docs, that follow a certain searchpattern(supports Lua patternmatching).
You can also check for case-sensitivity and if you want to search descriptions and tags as well.
the returned tables found_functions is of the format:
found_functions_desc[function_index]["functionname"] - the name of the function
found_functions_desc[function_index]["description"] - the entire description
found_functions_desc[function_index]["description_snippet"] - a snippet of the description that features the found pattern with 10 characters before and after it
found_functions_desc[function_index]["desc_startoffset"] - the startoffset of the found pattern; -1 if pattern not found in description
found_functions_desc[function_index]["desc_endoffset"] - the endoffset of the found pattern; -1 if pattern not found in description
found_functions_desc[function_index]["extension"] - the extension used, like Reaper, SWS, JS, ReaImGui, Osara, etc
found_functions_desc[function_index]["extension_version"] - the version of the extension
returns -1 in case of an error
Returnvalues:
| integer found_functions_count |
| the number of found functions that follow the search-pattern |
| table found_functions |
| a table with all found functions that follow the search pattern |
| table found_functions_desc |
a table with all found matches within descriptions, including offset.
Index follows the index of found_functions |
Parameters:
| string pattern |
| the search-pattern to look for a function |
| boolean case_sensitive |
| true, search pattern is case-sensitive; false, search-pattern is case-insensitive |
| optional boolean include_descriptions |
| true, search in descriptions; false, don't search in descriptions |
| optional boolean include_tags |
| true, search in tags; false, don't search in tags |
^
Docs_GetAllReaperApiFunctionnames
Lua: table slugs, table titles = ultraschall.Docs_GetAllReaperApiFunctionnames()
returns tables with all slugs and all titles of all Reaper-API-functions(usually the functionnames)
^
Docs_GetAllUltraschallApiFunctionnames
Lua: table slugs = ultraschall.Docs_GetAllUltraschallApiFunctionnames()
returns tables with all slugs of all Ultraschall-API-functions and variables
^
Docs_GetReaperApiFunction_Call
Lua: string functioncall = ultraschall.Docs_GetReaperApiFunction_Call(string functionname, integer proglang)
returns the functioncall of a function from the documentation
returns nil in case of an error
Returnvalues:
| string functioncall |
| the functioncall of the function |
Parameters:
| string functionname |
| the name of the function, whose description you want to get |
| integer proglang |
the programming-language for which you want to get the function-call
1, C
2, EEL2
3, Lua
4, Python |
^
Docs_GetReaperApiFunction_Call
Lua: string functioncall = ultraschall.Docs_GetReaperApiFunction_Call(string functionname, integer proglang)
returns the functioncall of a function from the documentation
returns nil in case of an error
Returnvalues:
| string functioncall |
| the functioncall of the function |
Parameters:
| string functionname |
| the name of the function, whose description you want to get |
| integer proglang |
the programming-language for which you want to get the function-call
1, C
2, EEL2
3, Lua
4, Python |
^
Docs_GetReaperApiFunction_Categories
Lua: integer categories_count, table categories = ultraschall.Docs_GetReaperApiFunction_Categories(string functionname)
returns the categories of a function from the documentation
Note: for gfx-functions, add gfx. before the functionname
returns -1 in case of an error
Returnvalues:
| integer categories_count |
| the number of categories for this function |
| table categories |
| the categories of this function |
Parameters:
| string functionname |
| the name of the function, whose categories you want to get |
^
Docs_GetReaperApiFunction_Description
Lua: string description = ultraschall.Docs_GetReaperApiFunction_Description(string functionname)
returns the description of a function from the documentation
Note: for gfx-functions, add gfx. before the functionname
returns nil in case of an error
Returnvalues:
| string description |
| the description of the function |
Parameters:
| string functionname |
| the name of the function, whose description you want to get |
^
Docs_GetReaperApiFunction_Description
Lua: string description = ultraschall.Docs_GetReaperApiFunction_Description(string functionname)
returns the description of a function from the documentation
Note: for gfx-functions, add gfx. before the functionname
returns nil in case of an error
Returnvalues:
| string description |
| the description of the function |
Parameters:
| string functionname |
| the name of the function, whose description you want to get |
^
Docs_GetReaperApiFunction_Params
Lua: integer paramscount, table params = ultraschall.Docs_GetReaperApiFunction_Params(string functionname)
returns the parameters of a function from the documentation
Note: for gfx-functions, add gfx. before the functionname
Table params is of the following structure:
params[paramsindex]["datatype"] - the datatype of this parameter
params[paramsindex]["name"] - the name of this parameter
params[paramsindex]["description"] - the description for this parameter
returns -1 in case of an error
Returnvalues:
| integer paramscount |
| the number of found parameters |
| table params |
| a table with all parameters |
Parameters:
| string functionname |
| the name of the function, whose parameter you want to get |
^
Docs_GetReaperApiFunction_Requires
Lua: integer requires_count, table requires, table requires_alt = ultraschall.Docs_GetReaperApiFunction_Requires(string functionname)
returns the requires of a function from the documentation
The requires usually mean dependencies of extensions with a specific version or specific Reaper-versions
Note: for gfx-functions, add gfx. before the functionname
returns -1 in case of an error
Returnvalues:
| integer requires_count |
| the number of requires for this function |
| table requires |
| the requires of this function |
| table requires_alt |
| like requires but has the require name as index, like Reaper or SWS |
Parameters:
| string functionname |
| the name of the function, whose requires you want to get |
^
Docs_GetReaperApiFunction_Retvals
Lua: integer retvalscount, table retvals = ultraschall.Docs_GetReaperApiFunction_Retvals(string functionname)
returns the returnvalues of a function from the documentation
Note: for gfx-functions, add gfx. before the functionname
Table retvals is of the following structure:
retvals[retvalindex]["datatype"] - the datatype of this retval
retvals[retvalindex]["name"] - the name of this retval
retvals[retvalindex]["description"] - the description for this retval
returns -1 in case of an error
Returnvalues:
| integer retvalscount |
| the number of found returnvalues |
| table retvals |
| a table with all return-values |
Parameters:
| string functionname |
| the name of the function, whose retvals you want to get |
^
Docs_GetReaperApiFunction_Tags
Lua: integer tags_count, table tags = ultraschall.Docs_GetReaperApiFunction_Tags(string functionname)
returns the tags of a function from the documentation
Note: for gfx-functions, add gfx. before the functionname
returns -1 in case of an error
Returnvalues:
| integer tags_count |
| the number of tags for this function |
| table tags |
| the tags of this function |
Parameters:
| string functionname |
| the name of the function, whose tags you want to get |
^
Docs_GetUltraschallApiFunction_Categories
Lua: integer tags_count, table tags = ultraschall.Docs_GetUltraschallApiFunction_Categories(string functionname)
returns the categories of an Ultraschall-API function from the documentation
returns -1 in case of an error
Returnvalues:
| integer categories_count |
| the number of categories for this function |
| table categories |
| the categories of this function |
Parameters:
| string functionname |
| the name of the function, whose categories you want to get |
^
Docs_GetUltraschallApiFunction_Description
Lua: string description = ultraschall.Docs_GetUltraschallApiFunction_Description(string functionname)
returns the description of an Ultraschall-API function from the documentation
returns nil in case of an error
Returnvalues:
| string description |
| the description of the function |
Parameters:
| string functionname |
| the name of the function, whose description you want to get |
^
Docs_GetUltraschallApiFunction_Params
Lua: integer paramscount, table params = ultraschall.Docs_GetUltraschallApiFunction_Params(string functionname)
returns the parameters of an Ultraschall-API function from the documentation
Table params is of the following structure:
params[paramsindex]["datatype"] - the datatype of this parameter
params[paramsindex]["name"] - the name of this parameter
params[paramsindex]["description"] - the description for this parameter
returns -1 in case of an error
Returnvalues:
| integer paramscount |
| the number of found parameters |
| table params |
| a table with all parameters |
Parameters:
| string functionname |
| the name of the function, whose parameter you want to get |
^
Docs_GetUltraschallApiFunction_Requires
Lua: integer requires_count, table requires, table requires_alt = ultraschall.Docs_GetUltraschallApiFunction_Requires(string functionname)
returns the requires of an Ultraschall-API function from the documentation
The requires usually mean dependencies of extensions with a specific version or specific Reaper-versions
returns -1 in case of an error
Returnvalues:
| integer requires_count |
| the number of requires for this function |
| table requires |
| the requires of this function |
| table requires_alt |
| like requires but has the require name as index, like Reaper or SWS |
Parameters:
| string functionname |
| the name of the function, whose requires you want to get |
^
Docs_GetUltraschallApiFunction_Retvals
Lua: integer retvalscount, table retvals = ultraschall.Docs_GetUltraschallApiFunction_Retvals(string functionname)
returns the returnvalues of an Ultraschall API function from the documentation
Table retvals is of the following structure:
retvals[retvalindex]["datatype"] - the datatype of this retval
retvals[retvalindex]["name"] - the name of this retval
retvals[retvalindex]["description"] - the description for this retval
returns -1 in case of an error
Returnvalues:
| integer retvalscount |
| the number of found returnvalues |
| table retvals |
| a table with all return-values |
Parameters:
| string functionname |
| the name of the function, whose retvals you want to get |
^
Docs_GetUltraschallApiFunction_Tags
Lua: integer tags_count, table tags = ultraschall.Docs_GetUltraschallApiFunction_Tags(string functionname)
returns the tags of an Ultraschall-API function from the documentation
returns -1 in case of an error
Returnvalues:
| integer tags_count |
| the number of tags for this function |
| table tags |
| the tags of this function |
Parameters:
| string functionname |
| the name of the function, whose tags you want to get |
^
Docs_LoadReaperConfigVarsDocBlocs
Lua: ultraschall.Docs_LoadReaperConfigVarsDocBlocs()
(re-)loads the config-var api-docblocs from the documentation, used by all Docs_GetReaperApi-functions
^
Docs_LoadUltraschallAPIDocBlocs
Lua: ultraschall.Docs_LoadUltraschallAPIDocBlocs()
(re-)loads the Ultraschall-API-api-docblocs from the documentation, used by all Docs_GetReaperApi-functions
^
Docs_GetAllUSDocBlocsFromFile
Lua: integer found_usdocblocs, array all_found_usdocblocs = ultraschall.Docs_GetAllUSDocBlocsFromString(string filename)
returns all US_DocBloc-elements from a file.
returns nil in case of an error
Returnvalues:
| integer found_usdocblocs |
| the number of found US_DocBlocs in the file |
| array all_found_usdocblocs |
| the individual US_DocBlocs found in the file |
Parameters:
| string filename |
| the file, from which to get all US-docblocs |
^
Docs_GetAllUSDocBlocsFromString
Lua: integer found_usdocblocs, array all_found_usdocblocs = ultraschall.Docs_GetAllUSDocBlocsFromString(string String)
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_Changelog
Lua: integer changelogscount, table changelogs = ultraschall.Docs_GetUSDocBloc_Changelog(string String, boolean unindent_description, integer index)
returns the changelog-entries of an US_DocBloc-entry
this returns the version-number of the software and the changes introduced in that version inside a table.
returns nil in case of an error
Returnvalues:
| integer changelogscount |
| the number of changelog-entries found |
| array changelogs |
all changelogs found, as an array
changelogs[index][1] - software-version of the introduction of the change, like "Reaper 6.23" or "US_API 4.2.006"
changelogs[index][2] - a description of the change |
Parameters:
| string String |
| a string which hold a US_DocBloc to retrieve the changelog-entry from |
| boolean unindent_description |
| true, will remove indentation as given in the changelog-tag; false, return the text as it is |
| integer index |
| the index of the changelog-entries, starting with 1 for the first |
^
Docs_GetUSDocBloc_ChapterContext
Lua: integer count, array chapters, string spok_lang = ultraschall.Docs_GetUSDocBloc_ChapterContext(string String, integer index)
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 chapternames 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_Deprecated
Lua: string what, string when, string alternative = ultraschall.Docs_GetUSDocBloc_Deprecated(string US_DocBloc)
returns the deprecated-tag of an US-DocBloc, which holds the information about, is a function is deprecated and what to use alternatively.
returns nil in case of an error or if no such deprecated-tag exists for this US_DocBloc
Returnvalues:
| string what |
| which software deprecated the function "Reaper" or "SWS" or "JS", etc |
| string when |
| since which version is this function deprecated |
| string alternative |
| what is a possible alternative to this function, if existing |
| string removed |
| function got removed |
Parameters:
| string US_DocBloc |
| a string which hold a US_DocBloc to retrieve the deprecated-tag-attributes from |
^
Docs_GetUSDocBloc_Description
Lua: 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)
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_Examples
Lua: integer num_code_examples, table code_examples = ultraschall.Docs_GetUSDocBloc_Examples(string String)
returns the code-examples from an US_DocBloc-element. The table
the returned table is of the following format:
code_examples[code_example_index]["name"] - the name of the example
code_examples[code_example_index]["description"] - a description of the example
code_examples[code_example_index]["url"] - the path to the code-example-file, usually based in the Documentation/Examples-folder
code_examples[code_example_index]["url_absolute"] - the absolute path to the code-example-file
code_examples[code_example_index]["author"] - the author of the example
returns nil in case of an error
Returnvalues:
| integer num_code_examples |
| the number or available code-examples |
| table code_examples |
| a table with all the code-example-attributes; each index is a code-example |
Parameters:
| string String |
| a string which hold a US_DocBloc to retrieve the code-example-attributes from |
^
Docs_GetUSDocBloc_Functioncall
Lua: string functioncall, string prog_lang = ultraschall.Docs_GetUSDocBloc_Functioncall(string String, integer index)
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_LinkedTo
Lua: integer linked_to_count, table links, string description = ultraschall.Docs_GetUSDocBloc_LinkedTo(string String, boolean unindent_description, integer index)
returns the linked_to-tags of an US_DocBloc-entry
returns nil in case of an error
Returnvalues:
| integer linked_to_count |
| the number of linked_to-entries found |
| array links |
all links found, as an array
links[index]["location"] - the location of the link, either inline(for slugs inside the same document) or url(for links/urls/uris outside of it)
links[index]["link"] - the slug to the element inside the document/the url or uri linking outside of the document
links[index]["description"] - a description for this link |
| string description |
| a description for this linked_to-tag |
Parameters:
| string String |
| a string which hold a US_DocBloc to retrieve the linked_to-entry from |
| boolean unindent_description |
| true, will remove indentation as given in the changelog-tag; false, return the text as it is |
| integer index |
| the index of the linked_to-entries, starting with 1 for the first |
^
Docs_GetUSDocBloc_NextChapter
Lua: string next_chapter = ultraschall.Docs_GetUSDocBloc_NextChapter(string String)
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 |
^
Docs_GetUSDocBloc_Params
Lua: 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)
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_PreviousChapter
Lua: string previous_chapter = ultraschall.Docs_GetUSDocBloc_PreviousChapter(string String)
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_Requires
Lua: integer count, array requires, array requires_alt = ultraschall.Docs_GetUSDocBloc_Requires(string String)
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_Retvals
Lua: 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)
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_Slug
Lua: string slug = ultraschall.Docs_GetUSDocBloc_Slug(string String)
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_SourceDocument
Lua: string source_document = ultraschall.Docs_GetUSDocBloc_SourceDocument(string String)
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_Tags
Lua: integer count, array tags, string spok_lang = ultraschall.Docs_GetUSDocBloc_Tags(string String, integer index)
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_TargetDocument
Lua: string target_document = ultraschall.Docs_GetUSDocBloc_TargetDocument(string String)
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_Title
Lua: string title, string spok_lang = ultraschall.Docs_GetUSDocBloc_Title(string String, integer index)
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_RemoveIndent
Lua: string unindented_text = ultraschall.Docs_RemoveIndent(string String, string indenttype)
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. |
| | | Automatically generated by Ultraschall-API 5 - 43 elements available
|
