Ditto Parameters
Parameter |
Description |
Default |
|---|---|---|
&archiveDateType |
Date type to display for archives (values can be createdon, pub_date, editedon) |
$dateFormatType |
&archivePlaceholder |
Output archive (older documents section) as a placeholder called |
0 |
&archiveText |
Text to use for the Archives listing |
$_lang['archives'] |
&commentsChunk |
If you're using comments, the name of the chunk used to format them so it can be filtered out |
'' |
&dateFormat |
Format for the date |
$_lang['date_format'] |
&debug |
Outputs debugging information |
0 |
&descendentDepth |
Number of levels deep to go |
1 |
&displayArchive |
Whether or not to show the archive |
1 |
&emptyText |
Text to be displayed when there are no results |
$_lang['no_entries'] |
&filter |
Only show items meeting a certain criteria. Different filters are | (pipe) delimited while each filter is comma delimited. documentobjectortvwithtvprefix, criteria |
|
&format |
Tells the snippet whether to output html, archive, JSON, or rss |
"html" |
&hiddenTVs |
Allows the snippet to filter by TV's not in the template. Separate by comma. |
"" |
&hideFolders |
Don't show folders in the returned results |
0 |
&mode |
Determines whether variable sanity checks are run. Use "development" while creating the snippet call and "production" when your site goes live for a little speed boost. |
"development" |
&paginate |
Toggles pagination support with either 0 or 1 |
0 |
&paginateAlwaysShowLinks |
Determine whether or not to always show previous next links |
0 |
&paginateSplitterCharacter |
Text delimiter to use if $paginateAlwaysShowLinks is disabled |
$_lang['button_splitter'] |
&seeThruUnpub |
Allows the snippet to see unpublished folders children |
0 |
&showInMenuOnly |
Allows you to show documents marked not to show in the menus |
0 |
&showPublishedOnly |
Allows you to filter out unpublished documents if needed |
1 |
&sortBy |
Field to sort by (recommended values include createdon, pub_date, editedon; reverts to createdon if value is invalid) |
"createdon" |
&sortDir |
Direction to sort by, either ASC (ascending) or DESC (descending) |
'DESC' |
&start |
Number of documents to start after. Can be passed in the URL via ?start=x |
0 |
&startID |
The folder that contains the documents you wish to display. Separate by commas to use multiple folders. Turn multiLevel on to get subchildren. |
Current Document |
&summarize |
Number of documents of which to show a summary, the remainder (to total) are displayed in the archive |
3 |
&tagData |
Source of data for tags, most likely a tv (with tv prefix) |
|
&tagDelimiter |
Character(s) used to split tags |
“ “ (space) |
&tagMode |
Method to remove tags, can either be onlyAllTags, removeAllTags, onlyTags, or removeTags. |
onlyTags |
&tags |
Tags to filter documents. Can be passed in the URL via ?tags=x |
|
&total |
Maximum number of documents to retrieve |
All requested |
&tpl |
User defined chunk name to format the summaries of the documents |
$_lang['default_template'] |
&tplAltRows |
User defined chunk name to format alternating rows |
$tpl |
&tplArch |
Optional user defined chunk name to format the archive summary posts |
$_lang['default_archive_template'] |
&tplArchiveNext |
Get the chunk code to be used inside the next <a> tag. |
$_lang['next'] |
&tplArchivePrevious |
Get the chunk code to be used inside the previous <a> tag. |
$_lang['prev'] |
&tplFirstRow |
User defined chunk name to format the first row |
$tpl |
&tplLastRow |
User defined chunk name to format the last row |
$tpl |
&trunc |
Should there be summary/short version of the documents? |
1 |
&truncAt |
Where to split the text |
$_lang['default_splitter'] |
&truncChars |
Truncate based on characters and not html tags |
0 |
&truncLen |
How many characters to show of documents |
300 |
&truncOffest |
How big of an offset to use to fall back when splitting mid-open tag |
30 |
&truncSplit |
Should the document be summarized at the "splitter"? |
1 |
&truncText |
Text to be displayed in a “Read more” link |
$_lang['more_text'] |
