[docbook] element index

Package indexes

• DocBookWiki
• admin
• webobjects

add_accessright_vars

docbook::add_accessright_vars() in docbook.php

add variables about access rights of the user

add_rs_modified_nodes

admin::add_rs_modified_nodes() in admin.php

add to webPage the recordset modified_nodes

add_rs_tags

tags::add_rs_tags() in tags.php

Add to webpage a recordset of tags.

admin

admin in admin.php

Some administration tasks about the book.

admin.php

admin.php in admin.php

add_file_revision

revisions::add_file_revision() in revisions.php

add the variable {{file_revision}}

add_rev_diff

revisions::add_rev_diff() in revisions.php

add {{rev_diff}}, the difference

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.

approve

approve in approve.php

Review and approve (or cancel) the modifications that are done to the current node of the book.

approve.php

approve.php in approve.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_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'

$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

append_line

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

append the current line to the given template

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.

$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

clear

revisions::clear() in revisions.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.

compact_cdata

compact_cdata() in process_content.php

Replace explicit CDATA like this:

create_new_node

create_new_node() in edit_funcs.php

create a new node and node files

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

$contents

Tpl::$contents in class.Tpl.php

$copyright

Info::$copyright in class.Info.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

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:

docbook

docbook in docbook.php

Handles the content of the book, editing, approving, navigation, etc.

docbook.php

docbook.php in docbook.php

delete_removefolders

delete_removefolders() in edit_funcs.php

delete_removefolders_all_langs

delete_removefolders_all_langs() in edit_funcs.php

display_error_messages

display_error_messages() in validate.php

display a popup window with error messages

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.

error_on_save

edit_content::error_on_save() in edit_content.php

expand_cdata

expand_cdata() in process_content.php

Replace implicit CDATA like this:

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

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

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.

funcs.php

funcs.php in funcs.php

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

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_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_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_node_state

get_node_state() in funcs.php

Reads the file state.txt of the current node and returns

get_state_filename

get_state_filename() in funcs.php

Returns the file state.txt of the current node.

get_book_dir

tags::get_book_dir() in tags.php

return the directory of the book: content/books/xml/book_id/lng/

get_current_tag

tags::get_current_tag() in tags.php

get_head_revision

tags::get_head_revision() in tags.php

get_revision_date

tags::get_revision_date() in tags.php

get_revision_nr

tags::get_revision_nr() in tags.php

get_svn_url

tags::get_svn_url() in tags.php

return the URL of the SVN repository: file://path/book_id/lng

get_title

admin::get_title() in admin.php

get_content_diff

approve::get_content_diff() in approve.php

get the modifications of content.xml

get_revision

revisions::get_revision() in revisions.php

return the content.xml at the selected revision (or date, or tag)

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_id_title

get_id_title() in convert_to_xml.php

returns the id and the title of the current node

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_short_xml_line

get_short_xml_line() in validate.php

extract from the xml line a part around the error

get_bullet

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

return the bullet of the given mark

get_current_line

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

get the current line that is being parsed

get_indentation

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

return the indentaion of the given mark

get_listitem_mark

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

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_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 ''.

html_to_xml

html_to_xml() in convert_to_xml.php

init

view::init() in view.php

init

docbook::init() in docbook.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_locked

is_locked() in funcs.php

Returns true if the node is locked and the lock has not expired.

is_fixed

tags::is_fixed() in tags.php

init

revisions::init() in revisions.php

init

edit_content::init() in edit_content.php

is_wellformed

is_wellformed() in convert_to_xml.php

Check that the given XML string is well formed.

$id

Tpl::$id in class.Tpl.php

$idx

WikiParser::$idx in class.WikiParser.php

$indent

Listing::$indent in class.Listing.php

Info

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

Info

Info in class.Info.php

Handle bookinfo or articleinfo elements.

$keywords

Info::$keywords in class.Info.php

langs

langs in langs.php

A list of languages in which the book is available.

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'.

locked_by_somebody

locked_by_somebody() in funcs.php

Returns true and displays a notification message, if the node is locked by another user.

langs.php

langs.php in langs.php

latex_to_xml

latex_to_xml() in convert_to_xml.php

lock_index

lock_index() in edit_funcs.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 in class.Listing.php

Listing

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

msg_book_fixed_to_tag

approve::msg_book_fixed_to_tag() in approve.php

mediaobject

mediaobject() in fun.regex_replace.php

Returns a <mediobject> element

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.

non_recursive_commit

approve::non_recursive_commit() in approve.php

non_recursive_revert

approve::non_recursive_revert() in approve.php

next_line

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

move the index to the nex line

nonempty_line

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

onParse

view::onParse() in view.php

onParse

docbook::onParse() in docbook.php

onRender

docbook::onRender() in docbook.php

onRender

langs::onRender() in langs.php

on_set_lng

docbook::on_set_lng() in docbook.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

onRender

admin::onRender() in admin.php

onRender

tags::onRender() in tags.php

on_add_tag

tags::on_add_tag() in tags.php

on_del_tag

tags::on_del_tag() in tags.php

on_set_date

tags::on_set_date() in tags.php

on_set_rev

tags::on_set_rev() in tags.php

on_set_tag

tags::on_set_tag() in tags.php

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

onRender

revisions::onRender() in revisions.php

onRender

approve::onRender() in approve.php

on_commit

approve::on_commit() in approve.php

on_hide

revisions::on_hide() in revisions.php

on_revert

approve::on_revert() in approve.php

on_save

revisions::on_save() in revisions.php

on_set_date

revisions::on_set_date() in revisions.php

on_set_lock

approve::on_set_lock() in approve.php

on_set_rev

revisions::on_set_rev() in revisions.php

on_set_tag

revisions::on_set_tag() in revisions.php

on_show

revisions::on_show() in revisions.php

onParse

edit::onParse() in edit.php

onRender

edit_content::onRender() in edit_content.php

onRender

edit::onRender() in edit.php

onRender

edit_media::onRender() in edit_media.php

on_add_subnode

edit::on_add_subnode() in edit.php

on_change_id

edit::on_change_id() in edit.php

on_change_title

edit::on_change_title() in edit.php

on_delete

edit::on_delete() in edit.php

on_delete

edit_media::on_delete() in edit_media.php

on_move_down

edit::on_move_down() in edit.php

on_move_up

edit::on_move_up() in edit.php

on_rename

edit_media::on_rename() in edit_media.php

on_save

edit_content::on_save() in edit_content.php

on_set_lock

edit::on_set_lock() in edit.php

on_set_mode

edit_content::on_set_mode() in edit_content.php

on_upload

edit_media::on_upload() in edit_media.php

process_index

process_index() in funcs.php

applies the given transformer to index.xml

popup_window

popup_window() in func.popup_window.php

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

Paragraph

Paragraph in class.Paragraph.php

Paragraph

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

package.WikiConverter.php

package.WikiConverter.php in package.WikiConverter.php

recursive_commit

approve::recursive_commit() in approve.php

recursive_revert

approve::recursive_revert() in approve.php

revisions

revisions in revisions.php

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

revisions.php

revisions.php in revisions.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

regex_replace

regex_replace() in fun.regex_replace.php

setup_webnotes

view::setup_webnotes() in view.php

set propper values to the parameters of the 'webnotes' component

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

set_all_synchronized

approve::set_all_synchronized() in approve.php

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>

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

texi_to_xml

texi_to_xml() in convert_to_xml.php

text_to_xml

text_to_xml() in convert_to_xml.php

transform_index

transform_index() in edit_funcs.php

Applies a transformation to index.xml and then writes the result back to index.xml.

$type

Tpl::$type in class.Tpl.php

template_list

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

(debug) Outputs the data of each template in $tpl_collection.

Text

Text::Text() in class.Text.php

Text

Text in class.Text.php

to_html

Block::to_html() in class.Block.php

to_html

Tpl::to_html() in class.Tpl.php

to_html

Paragraph::to_html() in class.Paragraph.php

to_html

Listing::to_html() in class.Listing.php

to_html

ListItem::to_html() in class.ListItem.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

Tpl::to_xml() in class.Tpl.php

to_xml

Info::to_xml() in class.Info.php

convert the info data to xml

to_xml

ListItem::to_xml() in class.ListItem.php

to_xml

Block::to_xml() in class.Block.php

to_xml

Listing::to_xml() in class.Listing.php

to_xml

Paragraph::to_xml() in class.Paragraph.php

Tpl

Tpl in class.Tpl.php

Tpl

Tpl::Tpl() in class.Tpl.php

Constructor

tpl_to_tree

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

(debug) Returns the structure of the loaded templates as a tree.

update_cache

update_cache() in funcs.php

Update the cache file content.html from content.xml

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_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.

view.php

view.php in view.php

view

view in view.php

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

validate.php

validate.php in validate.php

validate_xml

validate_xml() in validate.php

write_node_state

write_node_state() in funcs.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.

WikiParser

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

WikiParser

WikiParser in class.WikiParser.php

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