ad_include_contract (public)

 ad_include_contract docstring [ args... ]

Defined in packages/acs-tcl/tcl/tcl-documentation-procs.tcl

Define an interface between a page and an ADP <include> similar to the page_contract. This is a light-weight implementation based on the ad_page_contract. It allows one to check the passed arguments (types, optionality) and can be used for setting defaults the usual way. Using ad_include_contracts helps to improve documentation of included content.

Parameters:
docstring (required)
documentation of the include
Author:
gustaf neumann <neumann@wu-wien.ac.at>
Created:
Sept 2015
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_page_contracts page_contracts (test acs-tcl) ad_include_contract ad_include_contract test_page_contracts->ad_include_contract ad_page_contract ad_page_contract (public) ad_include_contract->ad_page_contract packages/acs-admin/lib/developer-services.tcl packages/acs-admin/ lib/developer-services.tcl packages/acs-admin/lib/developer-services.tcl->ad_include_contract packages/acs-admin/lib/password-update.tcl packages/acs-admin/ lib/password-update.tcl packages/acs-admin/lib/password-update.tcl->ad_include_contract packages/acs-admin/lib/service-parameters.tcl packages/acs-admin/ lib/service-parameters.tcl packages/acs-admin/lib/service-parameters.tcl->ad_include_contract packages/acs-admin/lib/site-wide-services.tcl packages/acs-admin/ lib/site-wide-services.tcl packages/acs-admin/lib/site-wide-services.tcl->ad_include_contract packages/acs-api-browser/lib/search.tcl packages/acs-api-browser/ lib/search.tcl packages/acs-api-browser/lib/search.tcl->ad_include_contract

Testcases:
page_contracts
[ show source ]
Show another procedure: