Full index

Package indexes

$

top

$const: $const in const.Options.php

a

top

$abstract: Info::$abstract in class.Info.php
$arr_lines: WikiParser::$arr_lines in class.WikiParser.php

lines that will be parsed and their index
$authors: Info::$authors in class.Info.php
addbook: addbook in addbook.php

This module is used to import a new book/article in the system or to create a new one. A list of the current books in the system is displayed as well and it is also possible to remove some books from the system.
add_accessright_vars: docbook::add_accessright_vars() in docbook.php

add variables about access rights of the user
add_all_users_rs: uList::add_all_users_rs() in uList.php

Constructs and adds to the webpage the recordset 'all_users' with all the users of the site.
add_books_rs: edit_menu::add_books_rs() in edit_menu.php

Add a recordset of all the books, which will be displayed in a listbox.
add_book_list_rs: books::add_book_list_rs() in books.php
add_book_title: books::add_book_title() in books.php
add_edit_rights: uEdit::add_edit_rights() in uEdit.php
add_file_revision: revisions::add_file_revision() in revisions.php

add the variable {{file_revision}}
add_has_accr: modified_nodes::add_has_accr() in modified_nodes.php

Find the modified nodes that can be approved by user and add them in the recordset.
add_is_admin: modified_nodes::add_is_admin() in modified_nodes.php

Add in the recordset all the modified nodes in the books for which the user is admin.
add_items_list: tabs1::add_items_list() in tabs1.php
add_nodetypes_rs: edit::add_nodetypes_rs() in edit.php

Create and add to webPage the recordset 'node_types' with the types of the nodes that can be added to the current node (preface, appendix, chapter, section, simplesect).
add_recordsets: book_list::add_recordsets() in book_list.php
add_rev_diff: revisions::add_rev_diff() in revisions.php

add {{rev_diff}}, the difference
add_rs_books_admin: user_data::add_rs_books_admin() in user_data.php

Add to webPage a recordset of the books for which the user is admin.
add_rs_langs: uEdit::add_rs_langs() in uEdit.php
add_rs_modified_nodes: admin::add_rs_modified_nodes() in admin.php

add to webPage the recordset modified_nodes
add_rs_nodes: uEdit::add_rs_nodes() in uEdit.php
add_rs_revs: revisions::add_rs_revs() in revisions.php

Add to webpage a recordset of revs.
add_rs_tags: revisions::add_rs_tags() in revisions.php

Add to webpage a recordset of tags.
add_rs_tags: tags::add_rs_tags() in tags.php

Add to webpage a recordset of tags.
add_subitems_rs: edit_menu::add_subitems_rs() in edit_menu.php

add a recordset of the subitems of the selected item
add_subsections_rs: add_subsections_rs() in edit_funcs.php

add the recordset 'subsections'
add_tab_items: edit_content::add_tab_items() in edit_content.php

Add to the webpage a recordset with the items of the tabs (modes).
add_to_modified_nodes: add_to_modified_nodes() in edit_funcs.php

Append the node path to the file 'modified_nodes.txt'
add_uploaded_files_rs: import_doc::add_uploaded_files_rs() in import_doc.php

create and add the recordset 'uploaded_files'
add_users_rs: uList::add_users_rs() in uList.php

Constructs and adds to the webpage the recordset 'users'.
add_users_rs: userList::add_users_rs() in userList.php

Constructs and adds to the webpage the recordset 'users'.
add_user_data: uEdit::add_user_data() in uEdit.php

get the user data and add them to the template
admin: admin in admin.php

Some administration tasks about the book.
ADMIN: ADMIN in const.Paths.php
admin: admin in admin.php

Modules and interfaces that are used by the superuser and by the book admins. Is accessed through 'admin.php'.
afterParse: help::afterParse() in help.php
append_line: WikiParser::append_line() in class.WikiParser.php

append the current line to the given template
approve: approve in approve.php

Review and approve (or cancel) the modifications that are done to the current node of the book.
APP_CONFIG_FILE: APP_CONFIG_FILE in const.Options.php

The file that contains additional configuration options, which are specific for the application.
author_to_xml: addbook::author_to_xml() in addbook.php

Gets a string like this: 'Surname, Firstname, email'
addbook.php: addbook.php in addbook.php
admin.php: admin.php in admin.php
admin.php: admin.php in admin.php
approve.php: approve.php in approve.php

b

top

$block_title: Block::$block_title in class.Block.php
$block_type: Block::$block_type in class.Block.php
$bullet: Listing::$bullet in class.Listing.php
Block: Block::Block() in class.Block.php
Block: Block in class.Block.php
block_end: WikiParser::block_end() in class.WikiParser.php
block_start: WikiParser::block_start() in class.WikiParser.php
books: books in books.php

A listbox of the books/articles in the system.
books: books in books.php

The books that the user can administrate.
BOOKS: BOOKS in const.Paths.php
book_fixed_to_tag: book_fixed_to_tag() in funcs.php

Check whether the public copy of the book is fixed to a certain tag or revision and return it. If book is not fixed, return false.
book_list: book_list in book_list.php

Displays a list of the current books in the system.
buildFilter: userFilter::buildFilter() in userFilter.php
book_list.php: book_list.php in book_list.php
books.php: books.php in books.php
books.php: books.php in books.php
book_list.php: book_list.php in book_list.php

c

top

$contents: Tpl::$contents in class.Tpl.php
$copyright: Info::$copyright in class.Info.php
CACHE: CACHE in const.Paths.php
changeid_movefolders: changeid_movefolders() in edit_funcs.php

move folders to the new node path, for all the languages
changeid_setid: changeid_setid() in edit_funcs.php

set the new id in content.xml, for all the languages
changeid_updatecache: changeid_updatecache() in edit_funcs.php
change_id_validate: change_id_validate() in edit_funcs.php

Returns true if the new id is OK, otherwise returns false.
check_book_id: main::check_book_id() in main.php

Checks whether the given book_id exists or not.
clear: revisions::clear() in revisions.php
compact_cdata: compact_cdata() in process_content.php

Replace explicit CDATA like this:
const.Debug.php: const.Debug.php in const.Debug.php
const.Options.php: const.Options.php in const.Options.php
const.Paths.php: const.Paths.php in const.Paths.php
CONTENT: CONTENT in const.Paths.php
convert_menu_items: convert_menu_items() in fun.regex_replace.php

This function gets a string like this: 'M_enu->S_ubmenu->MenuI_tem (Ctrl-C)' and returns a docbook code like this:
create_new_node: create_new_node() in edit_funcs.php

create a new node and node files
CSS: CSS in const.Paths.php
convert_from_xml.php: convert_from_xml.php in convert_from_xml.php
convert_to_xml.php: convert_to_xml.php in convert_to_xml.php
class.Block.php: class.Block.php in class.Block.php
class.Info.php: class.Info.php in class.Info.php
class.Listing.php: class.Listing.php in class.Listing.php
class.ListItem.php: class.ListItem.php in class.ListItem.php
class.Paragraph.php: class.Paragraph.php in class.Paragraph.php
class.Text.php: class.Text.php in class.Text.php
class.Tpl.php: class.Tpl.php in class.Tpl.php
class.WikiParser.php: class.WikiParser.php in class.WikiParser.php

d

top

DB_TYPE: DB_TYPE in const.Options.php

this constant defines the type of DB that the application uses it can be: "MySQL", "Oracle", "ODBC", "ProgreSQL", etc.
DEBUG_GOTO: DEBUG_GOTO in const.Debug.php

if this constant is true, the framework displays an alert
DEBUG_INCLUDES: DEBUG_INCLUDES in const.Debug.php

if this constant is true, the framework outputs a box
DEBUG_RECORDSETS: DEBUG_RECORDSETS in const.Debug.php

if this constant is true, the framework outputs all the
DEBUG_STATEVARS: DEBUG_STATEVARS in const.Debug.php

if this constant is true, the framework outputs the state
DEBUG_TEMPLATES: DEBUG_TEMPLATES in const.Debug.php

if this constant is true, the framework outputs the tree
DEBUG_WEBOBJECTS: DEBUG_WEBOBJECTS in const.Debug.php

if this constant is true, the framework outputs a box
delete_removefolders: delete_removefolders() in edit_funcs.php
delete_removefolders_all_langs: delete_removefolders_all_langs() in edit_funcs.php
DISPLAY_CGI_VARS: DISPLAY_CGI_VARS in const.Options.php

When this constant is true, then the CGI vars are displayed at the URL window of the browser. See also SHOW_EXTERNAL_LINK at const.Debug.php.
display_error_messages: display_error_messages() in validate.php

display a popup window with error messages
DOCBOOK: DOCBOOK in const.Paths.php
docbook: docbook in docbook.php

Handles the content of the book, editing, approving, navigation, etc.
docbook.php: docbook.php in docbook.php

e

top

edit: edit in edit.php

Edit the content of the current node.
edit_content: edit_content in edit_content.php
edit_media: edit_media in edit_media.php

Add, rename, delete the media files of the node.
edit_menu: edit_menu in edit_menu.php

Modify the menu of the categories and books.
edit_rights: edit_rights in edit_rights.php

Displays the edit rights of the user.
empty_line: WikiParser::empty_line() in class.WikiParser.php
end_of_lines: WikiParser::end_of_lines() in class.WikiParser.php

return true if the index is at the end of the lines
error_on_save: edit_content::error_on_save() in edit_content.php
EXECUTION_TIME_INFO: EXECUTION_TIME_INFO in const.Debug.php

if this constant is true, the framework outputs information
expand_cdata: expand_cdata() in process_content.php

Replace implicit CDATA like this:
edit_menu.php: edit_menu.php in edit_menu.php
edit_rights.php: edit_rights.php in edit_rights.php
edit_content.php: edit_content.php in edit_content.php
edit.php: edit.php in edit.php
edit_funcs.php: edit_funcs.php in edit_funcs.php
edit_media.php: edit_media.php in edit_media.php

f

top

file_content_html: file_content_html() in funcs.php

Returns the path of the content_lng.html for the given node and language.
file_content_xml: file_content_xml() in funcs.php

Returns the path of the content.xml for the given node and language.
FIRSTPAGE: FIRSTPAGE in const.Options.php

This is the first page of the application. The framework looks for it at the template folder (specified by TPL).
func.popup_window.php: func.popup_window.php in func.popup_window.php
func.popup_window.php: func.popup_window.php in func.popup_window.php
fun.regex_replace.php: fun.regex_replace.php in fun.regex_replace.php
funcs.php: funcs.php in funcs.php
func.languages.php: func.languages.php in func.languages.php

g

top

get_arr_books_accr: modified_nodes::get_arr_books_accr() in modified_nodes.php

Return an array with the books where the user has some access rights and is not admin.
get_arr_books_admin: modified_nodes::get_arr_books_admin() in modified_nodes.php

return an array of the books for which the user is admin
get_arr_languages: get_arr_languages() in func.languages.php

This function returns an associated array of language codes and language details (like language name, codeset, etc.).
get_arr_navigation: get_arr_navigation() in funcs.php

Reads from cache 'navigation.txt' for the given node and returns an associative array with the template variables this_path, next_path, prev_path, up_path, this_title, next_title, prev_title, up_title.
get_book_dir: tags::get_book_dir() in tags.php

return the directory of the book: content/books/xml/book_id/lng/
get_book_list: search::get_book_list() in search.php

Read the file books/book_list and return the associative array $arr_books, with keys 'book_id:lng' and with values 'book_title'.
get_book_list_arr: books::get_book_list_arr() in books.php
get_book_title: help::get_book_title() in help.php
get_book_title: main::get_book_title() in main.php
get_bullet: WikiParser::get_bullet() in class.WikiParser.php

return the bullet of the given mark
get_button_vars: docbook::get_button_vars() in docbook.php

Returns an associative array with keys 'edit', 'approve' and 'admin' and whith values 'true' or 'false', according to the access rights of the current user.
get_content_diff: approve::get_content_diff() in approve.php

get the modifications of content.xml
get_current_line: WikiParser::get_current_line() in class.WikiParser.php

get the current line that is being parsed
get_current_tag: tags::get_current_tag() in tags.php
get_date_str: get_date_str() in funcs.php

Converts the given time stamp to a date string.
get_edit_rights: docbook::get_edit_rights() in docbook.php

Reads the user edit rights file 'admin/access_rights/username'
get_head_revision: tags::get_head_revision() in tags.php
get_id_title: get_id_title() in convert_to_xml.php

returns the id and the title of the current node
get_indentation: WikiParser::get_indentation() in class.WikiParser.php

return the indentaion of the given mark
get_initial_xml: addbook::get_initial_xml() in addbook.php

constructs and returns an intial xml document
get_langs: uEdit::get_langs() in uEdit.php

Returns an array of languages (en,fr,it,al) in which the book is available.
get_langs: main::get_langs() in main.php

Returns an array of languages (en,fr,it,al) in which the book is available.
get_langs: help::get_langs() in help.php

Returns an array of languages (en,fr,it,al) in which the book is available.
get_legalnotice: addbook::get_legalnotice() in addbook.php
get_listitem_mark: WikiParser::get_listitem_mark() in class.WikiParser.php
get_media_path: edit_media::get_media_path() in edit_media.php
get_node_content: get_node_content() in process_content.php

Builds the content of the node by processing content.xml with xml2mode.xsl, and assigns it to a template variable.
get_node_references: get_node_references() in edit_funcs.php

Find the nodes that reference this one and return a list of them as a string (having a line for each node). The return value is empty string ('') if there are no referencies.
get_node_state: get_node_state() in funcs.php

Reads the file state.txt of the current node and returns
get_nr_of_recs: search::get_nr_of_recs() in search.php
get_nr_of_recs: userList::get_nr_of_recs() in userList.php
get_nr_of_recs: uList::get_nr_of_recs() in uList.php
get_page_vars: search::get_page_vars() in search.php
get_page_vars: userList::get_page_vars() in userList.php
get_page_vars: uList::get_page_vars() in uList.php
get_query: search::get_query() in search.php
get_results_rs: search::get_results_rs() in search.php

Returns a recordset of search results.
get_revision: revisions::get_revision() in revisions.php

return the content.xml at the selected revision (or date, or tag)
get_revision_date: tags::get_revision_date() in tags.php
get_revision_nr: tags::get_revision_nr() in tags.php
get_short_xml_line: get_short_xml_line() in validate.php

extract from the xml line a part around the error
get_state_filename: get_state_filename() in funcs.php

Returns the file state.txt of the current node.
get_subtemplates: Tpl::get_subtemplates() in class.Tpl.php

Returns an array of ids of the templates that are referenced from the contents of this template.
get_svn_status: approve::get_svn_status() in approve.php

Get the modifications made in media files
get_svn_url: revisions::get_svn_url() in revisions.php

return the URL of the SVN repository: file://path/book_id/lng
get_svn_url: tags::get_svn_url() in tags.php

return the URL of the SVN repository: file://path/book_id/lng
get_title: modified_nodes::get_title() in modified_nodes.php
get_title: admin::get_title() in admin.php
get_tpl_id: Tpl::get_tpl_id() in class.Tpl.php

If the given line is a reference to another template, returns the id of the referenced template, otherwise return empty string ''.
get_user_data: get_user_data() in user_data.php
GRAPHICS: GRAPHICS in const.Paths.php

h

top

has_approve_right: modified_nodes::has_approve_right() in modified_nodes.php

Returns true if the user has approve right on the given node.
help: help in help.php

Displays a section of docbookwiki_guide.
html_to_xml: html_to_xml() in convert_to_xml.php
help.php: help.php in help.php

i

top

$id: Tpl::$id in class.Tpl.php
$idx: WikiParser::$idx in class.WikiParser.php
$indent: Listing::$indent in class.Listing.php
import_doc: import_doc in import_doc.php

Import a new book or article in the system.
Info: Info::Info() in class.Info.php
Info: Info in class.Info.php

Handle bookinfo or articleinfo elements.
init: tabs1::init() in tabs1.php
init: search::init() in search.php
init: book_list::init() in book_list.php
init: view::init() in view.php
init: userList::init() in userList.php
init: books::init() in books.php
init: uList::init() in uList.php
init: revisions::init() in revisions.php
init: userEdit::init() in userEdit.php
init: userFilter::init() in userFilter.php
init: docbook::init() in docbook.php
init: admin::init() in admin.php
init: edit_content::init() in edit_content.php
init: edit_rights::init() in edit_rights.php
init: main::init() in main.php
init: languages::init() in languages.php
init: edit_menu::init() in edit_menu.php
is_admin: docbook::is_admin() in docbook.php

Returns 'true' if the current user is an admin for the current book, otherwise returns 'false'.
is_fixed: tags::is_fixed() in tags.php
is_locked: is_locked() in funcs.php

Returns true if the node is locked and the lock has not expired.
is_wellformed: is_wellformed() in convert_to_xml.php

Check that the given XML string is well formed.
import_doc.php: import_doc.php in import_doc.php
import_doc.php: import_doc.php in import_doc.php

k

top

$keywords: Info::$keywords in class.Info.php
keywords_to_xml: addbook::keywords_to_xml() in addbook.php

Gets a comma separated list of keywords: 'k1, k2, k3,'

l

top

langs: langs in langs.php

A list of languages in which the book is available.
languages: languages in languages.php

Languages of the application interface.
lang_match: docbook::lang_match() in docbook.php

Returns true if one of the language ids in the list matches the current language, otherwise returns false. The lang_list is a comma separated list of languages, or 'ALL'.
lang_match: modified_nodes::lang_match() in modified_nodes.php

Returns true if one of the language ids in the list matches the given language, otherwise returns false. The lang_list is a comma separated list of languages, or 'ALL'.
latex_to_xml: latex_to_xml() in convert_to_xml.php
line_to_html: Tpl::line_to_html() in class.Tpl.php
line_to_html: Text::line_to_html() in class.Text.php
line_to_html: Block::line_to_html() in class.Block.php
line_to_xml: Tpl::line_to_xml() in class.Tpl.php
line_to_xml: Text::line_to_xml() in class.Text.php
line_to_xml: Block::line_to_xml() in class.Block.php
link_template: WikiParser::link_template() in class.WikiParser.php

add a link from the parent template to the child template
Listing: Listing::Listing() in class.Listing.php
Listing: Listing in class.Listing.php
ListItem: ListItem in class.ListItem.php
ListItem: ListItem::ListItem() in class.ListItem.php
listitem_end: WikiParser::listitem_end() in class.WikiParser.php
listitem_start: WikiParser::listitem_start() in class.WikiParser.php
list_end: WikiParser::list_end() in class.WikiParser.php
list_start: WikiParser::list_start() in class.WikiParser.php

return true if the current line starts a new list
locked_by_somebody: locked_by_somebody() in funcs.php

Returns true and displays a notification message, if the node is locked by another user.
lock_index: lock_index() in edit_funcs.php
langs.php: langs.php in langs.php
languages.php: languages.php in languages.php

m

top

main: main in main.php

The stating point for constructing the web page.
mediaobject: mediaobject() in fun.regex_replace.php

Returns a <mediobject> element
MENU: MENU in const.Paths.php
modified_nodes: modified_nodes in modified_nodes.php

Displays a list of the modified nodes that can be approved by the user.
msg_book_fixed_to_tag: approve::msg_book_fixed_to_tag() in approve.php
menu_items.php: menu_items.php in menu_items.php
menu_items.php: menu_items.php in menu_items.php
modified_nodes.php: modified_nodes.php in modified_nodes.php
main.php: main.php in main.php
media_file.php: media_file.php in media_file.php

n

top

next_line: WikiParser::next_line() in class.WikiParser.php

move the index to the nex line
node_match: modified_nodes::node_match() in modified_nodes.php

Returns true if one of the node_path expressions in the list matches the given node path, otherwise returns false.
node_match: docbook::node_match() in docbook.php

Returns true if one of the node_path expressions in the list matches the current node path, otherwise returns false.
nonempty_line: WikiParser::nonempty_line() in class.WikiParser.php
non_recursive_commit: approve::non_recursive_commit() in approve.php
non_recursive_revert: approve::non_recursive_revert() in approve.php
NULL_VALUE: NULL_VALUE in const.Options.php

This constant is the value returned by the framework for a DB variable that has a NULL value. It can be "", "NULL", NULL, etc.

o

top

onParse: docbook::onParse() in docbook.php
onParse: userEdit::onParse() in userEdit.php
onParse: edit::onParse() in edit.php
onParse: languages::onParse() in languages.php
onParse: userFilter::onParse() in userFilter.php
onParse: search::onParse() in search.php
onParse: view::onParse() in view.php
onParse: admin::onParse() in admin.php
onParse: user_data::onParse() in user_data.php
onRender: main::onRender() in main.php
onRender: modified_nodes::onRender() in modified_nodes.php

First find the books where the user has some access rights.
onRender: languages::onRender() in languages.php
onRender: edit_rights::onRender() in edit_rights.php
onRender: edit_media::onRender() in edit_media.php
onRender: edit_menu::onRender() in edit_menu.php
onRender: import_doc::onRender() in import_doc.php
onRender: tabs1::onRender() in tabs1.php
onRender: userEdit::onRender() in userEdit.php
onRender: userList::onRender() in userList.php
onRender: user_data::onRender() in user_data.php
onRender: uList::onRender() in uList.php
onRender: uEdit::onRender() in uEdit.php
onRender: search::onRender() in search.php
onRender: edit_content::onRender() in edit_content.php
onRender: tags::onRender() in tags.php
onRender: revisions::onRender() in revisions.php
onRender: langs::onRender() in langs.php
onRender: edit::onRender() in edit.php
onRender: approve::onRender() in approve.php
onRender: docbook::onRender() in docbook.php
onRender: book_list::onRender() in book_list.php
onRender: books::onRender() in books.php
onRender: books::onRender() in books.php
onRender: admin::onRender() in admin.php
on_add: userEdit::on_add() in userEdit.php

add the new user in database
on_add_new: userList::on_add_new() in userList.php
on_add_subitem: edit_menu::on_add_subitem() in edit_menu.php

add a new subitem to the current item
on_add_subnode: edit::on_add_subnode() in edit.php
on_add_tag: tags::on_add_tag() in tags.php
on_add_user: uList::on_add_user() in uList.php
on_apply: edit_menu::on_apply() in edit_menu.php

apply the modifications to the main menu
on_approve: main::on_approve() in main.php
on_book: main::on_book() in main.php
on_cancel: edit_menu::on_cancel() in edit_menu.php

discard any modifications and get a copy of the main menu
on_change_id: edit::on_change_id() in edit.php
on_change_passwd: user_data::on_change_passwd() in user_data.php
on_change_title: edit::on_change_title() in edit.php
on_commit: approve::on_commit() in approve.php
on_create: addbook::on_create() in addbook.php
on_delete: uList::on_delete() in uList.php
on_delete: userEdit::on_delete() in userEdit.php

delete the current user
on_delete: edit::on_delete() in edit.php
on_delete: edit_menu::on_delete() in edit_menu.php

delete the current item and set the parent item as the current one
on_delete: import_doc::on_delete() in import_doc.php

delete an uploaded file
on_delete: userList::on_delete() in userList.php
on_delete: book_list::on_delete() in book_list.php
on_delete: edit_media::on_delete() in edit_media.php
on_del_tag: tags::on_del_tag() in tags.php
on_docbook: main::on_docbook() in main.php
on_help: search::on_help() in search.php
on_hide: revisions::on_hide() in revisions.php
on_import: import_doc::on_import() in import_doc.php
on_move_down: edit_menu::on_move_down() in edit_menu.php

move down the given item
on_move_down: edit::on_move_down() in edit.php
on_move_up: edit::on_move_up() in edit.php
on_move_up: edit_menu::on_move_up() in edit_menu.php

move up the given item
on_new_search: search::on_new_search() in search.php
on_next: userList::on_next() in userList.php
on_next: uList::on_next() in uList.php
on_next: search::on_next() in search.php
on_paste: edit_menu::on_paste() in edit_menu.php

add any items in clipboard as subitems of the current item
on_refresh: import_doc::on_refresh() in import_doc.php

refresh the list after uploading a file
on_refresh: userList::on_refresh() in userList.php
on_rename: edit_media::on_rename() in edit_media.php
on_revert: approve::on_revert() in approve.php
on_save: uEdit::on_save() in uEdit.php

save the changes
on_save: userEdit::on_save() in userEdit.php

save the changes
on_save: user_data::on_save() in user_data.php
on_save: revisions::on_save() in revisions.php
on_save: edit_content::on_save() in edit_content.php
on_search: main::on_search() in main.php
on_select: languages::on_select() in languages.php
on_select: help::on_select() in help.php

this event is called by xref.php
on_select: books::on_select() in books.php
on_select: edit_menu::on_select() in edit_menu.php

select an item for editing
on_select: uList::on_select() in uList.php
on_select: userList::on_select() in userList.php
on_select: tabs1::on_select() in tabs1.php
on_set_date: tags::on_set_date() in tags.php
on_set_date: revisions::on_set_date() in revisions.php
on_set_lng: docbook::on_set_lng() in docbook.php
on_set_lock: approve::on_set_lock() in approve.php
on_set_lock: edit::on_set_lock() in edit.php
on_set_mode: edit_content::on_set_mode() in edit_content.php
on_set_mode: docbook::on_set_mode() in docbook.php
on_set_node: docbook::on_set_node() in docbook.php
on_set_node_id: docbook::on_set_node_id() in docbook.php
on_set_rev: tags::on_set_rev() in tags.php
on_set_rev: revisions::on_set_rev() in revisions.php
on_set_tag: tags::on_set_tag() in tags.php
on_set_tag: revisions::on_set_tag() in revisions.php
on_set_visible: book_list::on_set_visible() in book_list.php
on_show: revisions::on_show() in revisions.php
on_update: edit_menu::on_update() in edit_menu.php

save modifications in id and caption of the current item
on_update_booklist: admin::on_update_booklist() in admin.php
on_update_downloadables: admin::on_update_downloadables() in admin.php
on_update_search_index: admin::on_update_search_index() in admin.php
on_upload: edit_media::on_upload() in edit_media.php
on_xref: main::on_xref() in main.php

this event is called by xref.php

p

top

Paragraph: Paragraph::Paragraph() in class.Paragraph.php
Paragraph: Paragraph in class.Paragraph.php
parse: Info::parse() in class.Info.php

Extract the various parts of the info section
parse_abstract: Info::parse_abstract() in class.Info.php
parse_author: Info::parse_author() in class.Info.php
parse_block: WikiParser::parse_block() in class.WikiParser.php
parse_copyright: Info::parse_copyright() in class.Info.php
parse_dummy: Info::parse_dummy() in class.Info.php
parse_file: WikiParser::parse_file() in class.WikiParser.php
parse_info: WikiParser::parse_info() in class.WikiParser.php
parse_keywords: Info::parse_keywords() in class.Info.php
parse_lines: WikiParser::parse_lines() in class.WikiParser.php
parse_list: WikiParser::parse_list() in class.WikiParser.php
parse_listitem: WikiParser::parse_listitem() in class.WikiParser.php
parse_paragraph: WikiParser::parse_paragraph() in class.WikiParser.php
parse_string: WikiParser::parse_string() in class.WikiParser.php
parse_text: WikiParser::parse_text() in class.WikiParser.php

parse the text wiki
popup_window: popup_window() in func.popup_window.php
process_index: process_index() in funcs.php

applies the given transformer to index.xml
process_index_node: process_index_node() in edit_funcs.php

Applies the given transformer to index.xml, passing the node as a parameter, and returns the output.
putback_cdata: putback_cdata() in process_content.php

replace <cdata>x</cdata> by the corresponding <![CDATA[...]]>
putback_comments: putback_comments() in process_content.php

replace <comment>x</comment> by the corresponding
process_content.php: process_content.php in process_content.php
package.WikiConverter.php: package.WikiConverter.php in package.WikiConverter.php

r

top

recursive_commit: approve::recursive_commit() in approve.php
recursive_revert: approve::recursive_revert() in approve.php
regex_replace: regex_replace() in fun.regex_replace.php
remove_from_modified_nodes: remove_from_modified_nodes() in edit_funcs.php

Remove the node path from the file 'modified_nodes.txt'
render_abstract: Info::render_abstract() in class.Info.php
render_authors: Info::render_authors() in class.Info.php
render_copyright: Info::render_copyright() in class.Info.php
render_keywords: Info::render_keywords() in class.Info.php
revisions: revisions in revisions.php

Handle (view, select) the previous revisions of the book.
revisions.php: revisions.php in revisions.php

s

top

save_user_data: save_user_data() in user_data.php
SCRIPTS: SCRIPTS in const.Paths.php
search: search in search.php

Search in the book(s) and display the results.
selectFirst: uList::selectFirst() in uList.php

set currentUser as the first user in the list
selectFirst: userList::selectFirst() in userList.php

set currentUser as the first user in the list
select_item: edit_menu::select_item() in edit_menu.php

Get the 'bookid' and the 'caption' of the selected item and refresh the state variables.
setup_webnotes: view::setup_webnotes() in view.php

set propper values to the parameters of the 'webnotes' component
set_all_synchronized: approve::set_all_synchronized() in approve.php
set_node_lock: set_node_lock() in funcs.php

Lock or unlock the current node.
set_node_status: set_node_status() in funcs.php

Set the status of the current node to the given new status.
set_revision: tags::set_revision() in tags.php
SHOW_ERROR_MESSAGES: SHOW_ERROR_MESSAGES in const.Debug.php

if this constant is false than the framework suppresses
SHOW_EXTERNAL_LINK: SHOW_EXTERNAL_LINK in const.Debug.php

If this constant is true, the framework outputs the external link that can be used to jump right to the current page of the application from any external page.
strip_cdata: strip_cdata() in process_content.php

replace <![CDATA[...]]> by <cdata>x</cdata>
strip_comments: strip_comments() in process_content.php

replace  by <comment>x</comment>
SVN: SVN in const.Paths.php
search.php: search.php in search.php

t

top

$type: Tpl::$type in class.Tpl.php
tabs1: tabs1 in tabs1.php
tags: tags in tags.php

Handle the tags of a book (create new tag, list existing tags, fix book to a tag, etc.)
tags.php: tags.php in tags.php
template_list: WikiParser::template_list() in class.WikiParser.php

(debug) Outputs the data of each template in $tpl_collection.
texi_to_xml: texi_to_xml() in convert_to_xml.php
Text: Text in class.Text.php
Text: Text::Text() in class.Text.php
text_to_xml: text_to_xml() in convert_to_xml.php
to_html: Block::to_html() in class.Block.php
to_html: Listing::to_html() in class.Listing.php
to_html: ListItem::to_html() in class.ListItem.php
to_html: Tpl::to_html() in class.Tpl.php
to_html: Paragraph::to_html() in class.Paragraph.php
to_html_table: Tpl::to_html_table() in class.Tpl.php

Debug function.
to_tree: WikiParser::to_tree() in class.WikiParser.php

Returns the structure of loaded templates as a tree.
to_xml: Listing::to_xml() in class.Listing.php
to_xml: Info::to_xml() in class.Info.php

convert the info data to xml
to_xml: Block::to_xml() in class.Block.php
to_xml: Paragraph::to_xml() in class.Paragraph.php
to_xml: ListItem::to_xml() in class.ListItem.php
to_xml: Tpl::to_xml() in class.Tpl.php
Tpl: Tpl in class.Tpl.php
Tpl: Tpl::Tpl() in class.Tpl.php

Constructor
TPL: TPL in const.Paths.php
tpl_to_tree: WikiParser::tpl_to_tree() in class.WikiParser.php

(debug) Returns the structure of the loaded templates as a tree.
transform: edit_menu::transform() in edit_menu.php

Applies the given xsl transformer to menu.xml and returns the result. $arr_params is an associative array of parameters.
transform_index: transform_index() in edit_funcs.php

Applies a transformation to index.xml and then writes the result back to index.xml.
transform_menu: edit_menu::transform_menu() in edit_menu.php
tabs1.php: tabs1.php in tabs1.php
tabs1_items.php: tabs1_items.php in tabs1_items.php

u

top

$user_data: userEdit::$user_data in userEdit.php
uEdit.php: uEdit.php in uEdit.php
uList.php: uList.php in uList.php
userEdit.php: userEdit.php in userEdit.php
userFilter.php: userFilter.php in userFilter.php
userList.php: userList.php in userList.php
user_data.php: user_data.php in user_data.php
user_data.php: user_data.php in user_data.php
uEdit: uEdit in uEdit.php

Admin the edit rights of a user(editor) of a book.
uList: uList in uList.php

The list of the users(editors) that can edit a book.
unlock_index: unlock_index() in edit_funcs.php
updatenavig_movedown: updatenavig_movedown() in edit_funcs.php
updatenavig_moveup: updatenavig_moveup() in edit_funcs.php
update_cache: update_cache() in funcs.php

Update the cache file content.html from content.xml
update_cache_files: update_cache_files() in edit_funcs.php
update_cache_files_all_langs: update_cache_files_all_langs() in edit_funcs.php
update_navigation: update_navigation() in edit_funcs.php

Update the file navigation.txt for the given node and language.
update_navigation_all_langs: update_navigation_all_langs() in edit_funcs.php

Update the files navigation.txt for all languages, for the given node.
update_subnodes_html: update_subnodes_html() in edit_funcs.php

Updates the cache files 'subnodes.html' for the given language, for the given node and all its ancestors, by applying 'update-subnodes.xsl' to index.xml.
update_subnodes_html_all_langs: update_subnodes_html_all_langs() in edit_funcs.php

Updates the cache files subnodes.html for the given node, for all its ancestors, and for all the languages.
upload_files: upload_files() in import_doc.php

Upload the files 'xml_file' and 'media_files'.
userEdit: userEdit in userEdit.php

userEdit modifies the details of a user (username, password, name, email and which books can admin).
userFilter: userFilter in userFilter.php

userFilter is used to select the users that are displayed in the list.
userList: userList in userList.php

userList displays the list of system users.
user_data: user_data in user_data.php

The user can change his data: name, email and password; he can also see which books he can manage, his edit rights and a list of nodes that are modified and he can approve.
USES_DB: USES_DB in const.Options.php

if this constant is true, the framework will load the DB component

v

top

validate.php: validate.php in validate.php
view.php: view.php in view.php
validate_xml: validate_xml() in validate.php
VAR_NOT_FOUND: VAR_NOT_FOUND in const.Options.php

This constant sets the format of the error message that is displayed when a {{variable}} is not found. 'var_name' is replaced by the actual variable name. Examples: "'var_name' is not defined", "", "undefined", etc. It cannot contain "{{var_name}}" inside.
view: view in view.php

Display the cache (html) file for the current node of the book.

w

top

WEBAPP_PATH: WEBAPP_PATH in const.Paths.php
WikiParser: WikiParser::WikiParser() in class.WikiParser.php
WikiParser: WikiParser in class.WikiParser.php
WOBJ: WOBJ in const.Paths.php
WORKSPACE: WORKSPACE in const.Paths.php
write_fixed_file: tags::write_fixed_file() in tags.php

Write the file 'fixed' which prevents the update of the latest changes of the book in the public copy.
write_node_state: write_node_state() in funcs.php
WS_BOOKS: WS_BOOKS in const.Paths.php
WS_CACHE: WS_CACHE in const.Paths.php

x

top

xml_to_html: xml_to_html() in convert_from_xml.php
xml_to_text: xml_to_text() in convert_from_xml.php
xml_to_xml: xml_to_xml() in convert_to_xml.php
XSLT: XSLT in const.Paths.php