This package allows for browsing the OpenACS/]po[ TCL API in a way similar to JavaDoc.
The API entry covers the procedures, content pages, library files, and SQL files for each seperate package installed on the system.
This package is only visible to ]po[ administrators.
(Screenshot of the API Doc Homepage, featuring a list of all currently installed packages. At the side of the list there are text fields that allow you to search for api procedures.)
(Screenshot of the results from an API search. Clicking on "show source" will lead you to the next page)
(The API browser highlights call to other procedures so that you can flollow by clicking on them.)
lib/search.adp lib/search.tcl tcl/acs-api-documentation-procs.tcl Routines for generating API documentation.
api_apropos_functions Returns the functions in the system that contain string in their name and have been defined using ad_proc. api_describe_function Describes the functions in the system that contain string and that have been defined using ad_proc. api_get_body This function returns the body of a Tcl proc or an xotcl method. api_library_documentation Generates formatted documentation for a Tcl library file (just the header, describing what the library does). api_proc_documentation Generates formatted documentation for a procedure. api_proc_link Returns a full HTML link to the documentation for the proc. api_proc_pretty_name Return a pretty version of a proc name api_proc_url Returns the URL of the page that documents the given proc. api_read_script_documentation Reads the contract from a Tcl content page. api_script_documentation Generates formatted documentation for a content page. api_type_documentation apidoc::ad_keywords_score returns number of keywords found in string to search. apidoc::ad_sort_by_first_string_proc basically a -1,0,1 result comparing the second element of the list inputs then the first. apidoc::ad_sort_by_score_proc basically a -1,0,1 result comparing the second element of the list inputs then the first. apidoc::ad_sort_by_second_string_proc basically a -1,0,1 result comparing the second element of the list inputs then the first (both strings) apidoc::first_sentence Returns the first sentence of a string. apidoc::format_author Extracts information about the author and formats it into an HTML string. apidoc::format_author_list Generates an HTML-formatted list of authors (including <code><dt></code> and <code><dd></code> tags). apidoc::format_changelog_change Formats the change log line: turns email addresses in parenthesis into links. apidoc::format_changelog_list Format the change log info apidoc::format_common_elements apidoc::format_see Takes the value in the argument "see" and possibly formats it into a link that will give the user more info about that resource apidoc::format_see_list Generate an HTML list of referenced procs and pages. apidoc::get_doc_url apidoc::get_xql_snippet apidoc::is_object Checks, whether the specified argument is an xotcl object. apidoc::pretty_token Encode the specified token in HTML apidoc::sanitize_path Return a sanitized path. apidoc::search_on_webindex Search for a matching link in the page and return the absolute link if found apidoc::set_public Gets or sets the user's public/private preferences for a given package. apidoc::tcl_to_html Given a proc name, formats it as HTML, including highlighting syntax in various colors and creating hyperlinks to other proc definitions.<BR> The inspiration for this proc was the tcl2html script created by Jeff Hobbs. apidoc::tclcode_to_html Given a script, this proc formats it as HTML, including highlighting syntax in various colors and creating hyperlinks to other proc definitions.<BR> The inspiration for this proc was the tcl2html script created by Jeff Hobbs. apidoc::xql_links_list Returns list of xql files related to Tcl script file
www/ | |
content-page-view.adp | |
content-page-view.tcl | Displays information about a content page. |
deprecated.adp | |
deprecated.tcl | returns a list of all the deprecated procedures present in server memory |
display-sql.adp | |
display-sql.tcl | Enables user to see a .sql file without encountering the AOLserver's db module magic (offering to load the SQL into a database) or without returning the SQL as content-type application/x-sql. |
index.adp | |
index.tcl | Offers links to other pages, and lets the user type the name of a specific procedure. |
package-view.adp | |
package-view.tcl | |
plsql-subprogram-one.adp | |
plsql-subprogram-one.tcl | Returns the specification for a given PL/SQL subprogram (package, procedure, or function). |
plsql-subprograms-all.adp | |
plsql-subprograms-all.tcl | Lists all subprograms (packages, procedures, or functions) in the database. |
proc-browse.adp | |
proc-browse.tcl | returns a list of all the procedures present in server memory |
proc-search.adp | |
proc-search.tcl | Searches for procedures with containing query_string if lucky redirects to best match Weight the different hits with the proper weights Shows a list of returned procs with links to proc-view Note: api documentation information taken from nsv array |
proc-view.adp | |
proc-view.tcl | Display information about one procedure. |
proc/ | |
index.vuh | |
procs-file-view.adp | |
procs-file-view.tcl | Displays procs in a Tcl library file. |
set-default.tcl | Set user preferences for API browsing. |
tcl-doc-search.adp | |
tcl-doc-search.tcl | Will redirect you to dev.scriptics.com if documentation can be found |
tcl-proc-view.adp | |
tcl-proc-view.tcl | Will redirect you to the server containing the documentation if it can be found |
type-view.adp | |
type-view.tcl | Displays information about a type. |
Calle Aprestadora 19, 12o-2a
08902 Hospitalet de Llobregat (Barcelona)
Spain
Tel Europe: +34 609 953 751
Tel US: +1 415 200 2465
Mail: info@project-open.com