Home Area Assets

• Base Asset
• Named Asset
• Folder Contained Asset
• Reference Asset
• Stylesheet Asset
• Template Asset
• Dublin Aware Asset
• Expiring Asset
• Symlink
• Block
• Feed Block
• Index Block
• Text Block
• XHTML Block
• XML Block
• Publishable Asset
• File
• Folder
• Page

NEWS & TIPS

• Site Access Keys
• Top: Alt+t
  Previous: Alt+,
  Next: Alt+.
  Up: Alt+;
  (Note: use Ctrl on the Mac)

Index Block

An index block is defined by the following WSDL:

<complexType name="indexBlock"> <complexContent> <extension base="impl:block"> <sequence> <element maxOccurs="1" minOccurs="1" name="indexedFolderId" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="indexedFolderPath" type="xsd:string"/> <element maxOccurs="1" minOccurs="1" name="maxRenderedAssets" type="xsd:nonNegativeInteger"/> <element maxOccurs="1" minOccurs="1" name="depthOfIndex" type="xsd:nonNegativeInteger"/> <element maxOccurs="1" minOccurs="1" name="includePageContent" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="includeCurrentPageXML" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="renderCurrentPageAndHierarchy" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="includeChildrenInHierarchy" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexPages" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexBlocks" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexLinks" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexFiles" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexRegularContent" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexSystemMetadata" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexUserMetadata" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexAccessRights" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexUserInfo" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="indexWorkflowInfo" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="appendCallingPageData" type="xsd:boolean"/> <element maxOccurs="1" minOccurs="1" name="sortMethod" type="xsd:string"/> </sequence> </extension> </complexContent> </complexType>

An index block contains many fields, most of which are options for what exactly should be included in the rendered XML of the index block. The boolean and numeric fields are self-explanitory, and the "indexedFolderId" or "indexedFolderPath" property is as well. One field of note is the sort method ("sortMethod"), which specifies how assets are sorted in individual folders before those assets are rendered into the XML content of the block. This property takes a String, one of " folder-order", " alphabetical", " last-modified-date", and " created-date", which are self-explanitory.

Comments

Wiki | Edit