Difference between revisions of "Template:Dataformview plugin info"

Jump to: navigation, search
Line 2: Line 2:
  
 
{{{description|}}}
 
{{{description|}}}
 
 
==Settings==
 
==Settings==
 
{{{general settings|
 
{{{general settings|
Line 22: Line 21:
 
Note that in order to apply the submission settings you must enable at least one submit button.
 
Note that in order to apply the submission settings you must enable at least one submit button.
 
====Display when editing====
 
====Display when editing====
*'''Display mode'''
+
*'''Show only edited entries''' – (Default) When editing one or more entries the view will display only the edited entries.   
**'''Show only edited entries''' – (Default) When editing one or more entries the view will display only the edited entries.   
+
*'''Show edited entries separate''' – When editing one or more entries the view will display the edited entries above the rest of the entries.
**'''Show edited entries separate''' – When editing one or more entries the view will display the edited entries above the rest of the entries.
+
*'''Show edited entries inline''' – When editing one or more entries the view will display the edited entries blended with other entries according to their display order.
**'''Show edited entries inline''' – When editing one or more entries the view will display the edited entries blended with other entries according to their display order.
 
 
====Submission buttons====   
 
====Submission buttons====   
 
*'''Save''' - Saves the edited entry and returns to the view.
 
*'''Save''' - Saves the edited entry and returns to the view.
*'''Save and Continue''' - Saves the edited entry and continues editing.
+
*'''Save and Continue''' - Saves the edited entry and remains in the form to continue editing the entry.
*'''Save as New''' - Saves the edited entry as a new entry and returns to the view.
+
*'''Save as New''' - Saves the edited entry as a new entry (the original entry is not changed) and returns to the view.
 
*'''Save and Start New''' - Saves the edited entry and opens a new entry form.
 
*'''Save and Start New''' - Saves the edited entry and opens a new entry form.
*'''Save as New and Continue''' - Saves the edited entry as a new entry and opens a new entry form.
+
*'''Save as New and Continue''' - Saves the edited entry as a new entry (the original entry is not changed) and remains in the form to continue editing the new entry.
 
*'''Cancel''' - Cancels submission and returns to the view.
 
*'''Cancel''' - Cancels submission and returns to the view.
 
====Redirection====
 
====Redirection====

Revision as of 21:37, 6 March 2014


Settings

General settings

Name

Short name for the view. The view name can be used in certain view patterns in which case the format of the name should as simple as possible, only alpha or alphanumeric characters, to avoid pattern parsing problems.

Description

Short description of the view purpose and characteristics to allow managers to see at a glance what each view is intended for. This description is displayed only in the view management list.

Visibility

This setting allows denying access to the view without the viewaccesshidden capability. By default Students cannot access hidden views.

Filter

A predefined filter from the Filters list (if any) that will be enforced in the view.

Per page

The max number of entries to display in the view at any given time. If the number of viewable entries is higher than the selected per-page a paging bar will be displayed (provided the ##pagingbar## is added to the view template).


Submission

The submission settings allow you to determine the behaviour of the view when editing entries. Depending on your activity application, you can display different submission buttons with default or custom labels, display all or only the edited entries and show a response to the submission. Note that in order to apply the submission settings you must enable at least one submit button.

Display when editing

  • Show only edited entries – (Default) When editing one or more entries the view will display only the edited entries.
  • Show edited entries separate – When editing one or more entries the view will display the edited entries above the rest of the entries.
  • Show edited entries inline – When editing one or more entries the view will display the edited entries blended with other entries according to their display order.

Submission buttons

  • Save - Saves the edited entry and returns to the view.
  • Save and Continue - Saves the edited entry and remains in the form to continue editing the entry.
  • Save as New - Saves the edited entry as a new entry (the original entry is not changed) and returns to the view.
  • Save and Start New - Saves the edited entry and opens a new entry form.
  • Save as New and Continue - Saves the edited entry as a new entry (the original entry is not changed) and remains in the form to continue editing the new entry.
  • Cancel - Cancels submission and returns to the view.

Redirection

  • Target view - By default the user remains in the same view after entry submission. If an alternate view of the activity is selected, the user will be redirected to that view after submission.
  • Response timeout - The delay (in seconds) after submission and before the user is redirected to the target view.
  • Response to submission - A message to display to the user after successful submission and before the user is redirected to the target view.


View template

TBC


Patterns

Common view patterns

Entries

##notifications##

Displays entry action notifications such “Updated 3 entries”, “Deleted 10 entries”, etc.

##numentriestotal##

Displays the total number of entries in the activity.

##numentriesviewable##

Displays the number of entries the current user can view in the activity without filtering.

##numentriesfiltered##

Displays the number of viewable entries with filters applied.

##numentriesdisplayed##

Displays the number of entries displayed.

##newentry##

Displays a new entry form (if user has permission to add).

##entries##

Displays the entries.

##addnewentry##

Displays 'Add new entry' action link that allows the user to open a new entry form.

##addnewentries##

Displays 'Add new entries' dropdown that allows the user to open the selected number of new entries in the form.

Reference

##viewurl##
##viewsmenu##
##filtersmenu##

Search and filtering

##quicksearch##
##quickperpage##
##advancedfilter##

Paging bar

##pagingbar##
##pagingbar:next##
##pagingbar:previous##

Additional patterns

This view does not provide additional patterns.


Copy and complete the following code to document a dataformview plugin:

{{Dataformview
|description = Enter a short description of the view with an illustration if applicable.
|usage = Enter usage description if the view provides specialized functionality in addition or instead of the standard functionality of displaying entries. For example, the dataformview_csv view provides the specialized functionality of csv import and export of entries. The content of this parameter resides under a level 2 Usage heading and sub-headings should start from level 3. 
|general settings = Enter description of general settings if different from the base general settings. Defaults to base general settings.
|submission settings = Enter description of submission settings if different from the base submission settings. Defaults to base submission settings.
|view template = Enter description of view template settings if different from the base view template settings. Defaults to base view template settings.
|other settings = Enter description of any other settings available in the view configuration form.
|common patterns = Enter description of common view patterns if different from the base common view patterns. Defaults to base common view patterns.
|additional patterns = Enter description of any additional patterns provided by the view if any.
}}