Ditto parameters and placeholders
This is as full a list as I can find of parameters and placeholder for Ditto 2.1 and standard extensions to it. Much has been culled from the official ditto.modxcms.com site. The order is somewhat ad hoc, and is more or less in the sequence "set up Ditto, set up the retrieval, set up the retrieved list, format the display", with some of the less vital templates and less used features towards the bottom.
Parameters for summary extender
- &trunc
- Purpose:Enable truncation of the text that goes into the [+summary+] placeholder
- Values:0,1
- Default:1
- &truncAt
- Purpose:Marker string to split the content at
- Values:Any unique text or code string that is contained in the content of each document.
- Default:<!-- splitter -->
- Notes:$_lang['splitter']
- &truncSplit
- Purpose:Should the document be summarized at the splitter?
- Values:0,1
- Default:1
- &truncLen
- Purpose:Number of characters to show of the content
- Values:Any number greater than &truncOffset
- Default:200
- &truncOffset
- Purpose:Number of characters to 'wander' either way of truncLen
- Values:Any number greater less than truncLen
- Default:20
- &truncText
- Purpose:Text to be displayed in [+link+]
- Values:Any valid text or html
- Default:Read more...'
- Notes:$_lang['more_text']
- &tplTrunc
- Purpose:Template to be used for [+link+]
- Values:chunk name; code via @CODE:file via @FILE:
- Default:&truncText
- Notes:Placeholders:
Parameters for request extender
- &stripTags
- Purpose:Remove HTML tags from supplied parameters
- Values:0,1
- Default:1
- &bad
- Purpose:Parameters not allowed to be set via extender
- Values:Ditto options separated by commas
- Default:seeThroughtUnpub, showInMenuOnly, showPublishedOnly, debug, start, config, extenders, dittoID
- &good
- Purpose:Parameters that may be set via extender
- Values:Ditto options separated by commas
- Default:Everything not in 'bad' list
Parameters for tagging extender
- &tagDocumentID
- Purpose:ID for tag links to point to
- &tagData
- Purpose:Document field for template variable containing tags
- &tags
- Purpose:Set tags for filtering
- Values:any valid tags separated by &tagDelimiter
- Default:empty
- Notes:Alternative to supplying them in URL
- &tagMode
- Purpose:Select or hide documents with all or any of the tags
- Values:onlyAllTags show documents that have all of the tags onlyTags show documents that have any of the tags removeAllTags remove documents that have all of the tags removeTags documents that have any of the tags
- Default:onlyTags
- &tagDelimiter
- Purpose:Separator between tags
- Values:Any character not used within the tags
- Default:space
- &caseSensitive
- Purpose:Make tag matching and duplicate tag removal case sensitive
- Values:0,1
- Default:0
- &tagDisplayDelimiter
- Purpose:Separator between tags in display
- Values:Character string
- Default:&tagDelimiter
- &tagSort
- Purpose:Sort the tags alphanumerically
- Values:0,1
- Default:1
- &tagDisplayMode
- Purpose:Display format of tags in [+tagLinks+]
- Values:1 (string of links &tagDisplayDelimiter separated), 2 (UL/LI list)
- Default:1
- &tplTagLinks
- Purpose:Output template for the [+tagLinks+] placeholder
- Values:chunk name; code via @CODE:file via @FILE:
- &tagCallback
- Purpose:Set name of function to handle source and processing of tags
- Values:Any valid function name
- Default:empty
- Notes:See http://ditto.modxcms.com/files/assets/snippets/ditto/extenders/tagging-extender-inc-php.html#tagCallback for details
Parameters for dateFilter extender
- &dateFilterSource
- Purpose:Source of filter data
- Values:get, params, name of $_REQUEST variable
- Default:get
- Notes:from URL (prefixed with any Ditto ID)
- &dateFilterDefault
- Purpose:Set default filter to current year, month or day
- Values:0,1,2,3 (off, this year, this month, today)
- Default:0 (off)
- &month
- Purpose:Month to filter by
- Values:Numerical month value
- Default:empty
- &year
- Purpose:Year to filter by
- Values:Year (2 or 4-digit)
- Default:empty
- &day
- Purpose:Day to filter by
- Values:Numerical day of the month
- Default:empty