Updated some params.
diff --git a/SocParams.wiki b/SocParams.wiki index 56840e2..d05dd5f 100644 --- a/SocParams.wiki +++ b/SocParams.wiki
@@ -6,10 +6,10 @@ Parameters are usually system-wide and they contain information for handling redirects, templates, sidebar entries, url patterns, dynamic fields & forms, and more in views. Parameters related methods are defined in *soc.views.helper.params*: * *constructParams(params)* receives a dictionary type argument with predefined parameters. _constructParams_ defines the default values (_newParams_) for all or most of the parameters and then it merges them with _params_. If defined, values in _params_ are going to override any values in _newParameters_. Some default values are shown below, for a complete list see this method. - * *getDynaFields(fields)* - * *getEditForm(params, base_form)* - * *getAdminForm(base_form)* - * *getKeyFieldsPattern(params)* + * *getDynaFields(fields)* Retrieves the fields for the Dynaform class + * *getEditForm(params, base_form)* Retrieves the form used on the edit page + * *getAdminForm(base_form)* + * *getKeyFieldsPattern(params)* Retrieves the pattern for the keyfields * *getPattern(params)* * *getScopePattern(params)* @@ -19,8 +19,8 @@ * *edit_redirect* defines the url pattern for redirection to the edit page. It is used on public pages, for example document's public page for generating the "Edit this document" link. * *missing_redirect* defines the url pattern for redirection to the page that should be displayed if the entity is missing. * *delete_redirect* defines the url pattern for redirection after deleting an entity. - * *cancel_redirect* ? - * *public_redirect* ? + * *cancel_redirect* defines the URL when the cancel button is pressed on the edit page + * *public_redirect* defines the URL for redirecting to the entities Public page == Url patterns == @@ -30,8 +30,8 @@ * *sans_link_id_pattern* * *no_edit* if defined the default edit url pattern will not be included in _django_patterns_defaults_ * *no_delete* if defined the default delete url pattern will not be included in _django_patterns_defaults_ - * *no_create_raw* - * *no_list_raw* + * *no_create_raw* if defined the URL pattern for creation without any keyfields is not included + * *no_list_raw* if defined the URL pattern for the list page without keyfields is not included * *no_show* if defined the default public page url pattern will not be included in _django_patterns_defaults_ * *no_admin* if defined the default admin url pattern will not be included in _django_patterns_defaults_ * *sans_link_id_create* @@ -40,9 +40,9 @@ * *django_patterns* if defined they are going to be the only url patterns used for a specific view. * *extra_django_patterns* this is where you should define any additional django patterns to be used with _django_patterns_default_. They are omited if _django_patterns_ is defined. * *django_patterns_default* are the default django url patterns and they will be used if _django_patterns_ isn't defined. They are dynamicaly constructed in _constructParams_. - * *no_create_with_scope* - * *no_create_with_key_fields* - * *key_fields_pattern* + * *no_create_with_scope* The URL pattern for the create page with a given scope is not included + * *no_create_with_key_fields* The URL pattern for the create page with all the key fields is no included + * *key_fields_pattern* pattern for the keyfields of an entity == Sidebar == @@ -64,9 +64,6 @@ * *admin_template* is used in the entity's admin page * *list_template* is used in the entity's list page * *list_main* is the list layout django template for the list page ? - * *list_pagination* is used for lists with pagination ? - * *list_row* is used for list rows ? - * *list_heading* is used for list heading ? * *error_public* is used for showing errors in the public page ? * *error_export* is used for showing errors in the export page.? It defaults to _error_public_. * *error_edit* is used for showing errors in the edit page. ? It defaults to _error_public_. @@ -85,7 +82,7 @@ * *module_name* is the module name. * *url_name* is the module name used in the url. Defaults to _module_name_. * *document_prefix* - * *list_msg* + * *list_msg* Default message used on the lists page == Exporting == @@ -106,19 +103,19 @@ == Needs to be sorted and defined == - * *rights* - * *logic* + * *rights* The rights instance this View uses for checking access + * *logic* The Logic instance this View uses * *pickable* - * *list_params* - * *submit_msg_param_name* + * *list_params* Defines the mapping of params entry to an entry that is used in generating lists + * *submit_msg_param_name* Name of the parameter appended to URL when a form is submitted to show the saved message. * *edit_params* * *cannot_delete_params* * *dynabase* * *references* * *create_dynainclude* - * *create_dynaexclude* - * *create_dynaproperties* - * *edit_dynaproperties* - * *create_form* - * *edit_form* - * *admin_form* \ No newline at end of file + * *create_dynaexclude* Form fields to exclude from the create/edit form per default + * *create_dynaproperties* Properties for the Create form + * *edit_dynaproperties* Properties for the Edit form + * *create_form* Form used on the default Create page for this View + * *edit_form* Form used on the default Edit page for this View + * *admin_form* Admin Form \ No newline at end of file