apidoc::format_see (public)
apidoc::format_see see
Defined in packages/acs-api-browser/tcl/acs-api-documentation-procs.tcl
Takes the value in the argument "see" and possibly formats it into a link that will give the user more info about that resource
- Parameters:
- see - a string expected to contain the resource to format
- Returns:
- the html string representing the resource
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- acs_api_browser_apidoc_format_see
Source code: #regsub -all -- {proc *} $see {} see set see [string trim $see] if {[nsv_exists api_proc_doc $see]} { set href [export_vars -base /api-doc/proc-view {{proc $see}}] return [subst {<a href="[ns_quotehtml $href]">$see</a>}] } set see [string trimleft $see :] if {[nsv_exists api_proc_doc $see]} { set href [export_vars -base /api-doc/proc-view {{proc $see}}] return [subst {<a href="[ns_quotehtml $href]">$see</a>}] } if {[string match "/doc/*" $see] || [util_url_valid_p $see]} { return [subst {<a href="[ns_quotehtml $see]">$see</a>}] } if {[file exists "$::acs::rootdir${see}"]} { set href [export_vars -base content-page-view {{source_p 1} {path $see}}] return [subst {<a href="[ns_quotehtml $href]">$see</a>}] } return $seeXQL Not present: Generic, PostgreSQL, Oracle