Term selector datatype

Transcription

1 Term selector datatype Installation Guide Xuntos B.V. Oktober 2012

2 Table of Contents Introduction... 3 XML Data save example... 3 Revision History... 3 Before installing this package... 4 Installation using package management... 4 Add the datatype... 5 Configuring the datatype... 6 Example Macro... 7 Package contents

3 Introduction This package contains the term selector and the corresponding (example) thesaurus doctypes. Selected terms/tags are stored in xml with or without the chosen weights (you can turn this off in the datatype). The datatype retrieves the terms from the configured thesaurus. Pic1: Example of selected terms. Current functionality: Select tags/terms using datatype Ability to add your own terms to the thesaurus (auto add functionality in the future!) Provide extra weight to terms using the + - buttons for each term Selected terms are saved in XML The tag webservice automatically hooks in during typing Selected tags/terms can be rearranged using drag and drop XML Data save example <terms> <term nodeid="1159" weight="0.75">actionhandler</term> <term nodeid="1166" weight="0.5">cache</term> <term nodeid="1178" weight="0.625">e-commerce</term> </terms> Revision History Version 0.9, Oktober Initial install guide 3

4 Before installing this package This package has been created for Umbraco v and above. This package requires the ucomponents extension v or above. Before installing ucomponents please install the workaround. Umbraco 4.8 breaks support for ucomponents. For more information about the issue, please read: Installation using package management After successfully installing ucomponents this package can be installed using the Umbraco package management. Download the zip file (XFS_Term_Selector.zip) and go to Install local package. Select I understand the security risks associated with installing a local package Select the zip file and click on the Load Package button Select Accept license Be patient during install and the Package is installed page is displayed Restart your site to activate the relation term boxes on the relation tab. Due to an Umbraco issue these boxes (ucomponents controls) are empty after publishing. To install the sample thesaurus and terms please install the zip file using the umbraco package management (XFS_Term_Selector_Sample terms.zip). Navigate to the content section and the demo thesaurus Umbraco Terms Publish this node (including all children), the following dialog is showed: Note If for some reason the package installation fails (due to permissions or other reasons). Follow the manual uninstall process: Delete the thesaurus items (tree) in the content section Delete the following documenttypes: XFS Term, XFS Term Folder, XFS Thesaurus, BaseThesaurus Uninstall the package(s) using the installed package folder in the developer section 4

5 Add the datatype Open the preferred documenttype where you want to add the term selector Click on the Generic properties tab Click on the button Click here to add a new property Configure the property using this settings: Save the documenttype using the save button Using the datatype Navigate to the Umbraco node where you want to add some terms. When you type ma, the following terms are displayed: (the sample terms zip file should be installed). Note The terms can be rearranged using drag and drop If configured the weight of the term can be changed 5

6 Configuring the datatype Thesaurus: select the thesaurus which is used in the lookup of the terms Use weights: when checked, the control renders + - buttons for each term. This allows you to change the default weight of each term. Debug: for developers to see the stored XML data 6

7 Example Macro The following xslt shows you the saved terms for a single page. <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE xsl:stylesheet [ <!ENTITY nbsp " "> ]> <xsl:stylesheet version="1.0" xmlns:xsl=" xmlns:msxml="urn:schemas-microsoft-com:xslt" xmlns:umbraco.library="urn:umbraco.library" exclude-result-prefixes="msxml umbraco.library"> <xsl:output method="xml" omit-xml-declaration="yes"/> <xsl:param name="currentpage"/> <xsl:template match="/"> <xsl:if test="count($currentpage/terms/terms/term)!=0"> <h2>selected terms:</h2> <ul> <xsl:for-each select="$currentpage/terms/terms/term"> <li> <xsl:value-of select="."/> </li> </xsl:for-each> </ul> </xsl:if> </xsl:template> </xsl:stylesheet> 7

8 Package contents If you want to know which files are installed, here is the list. Document Types BaseThesaurus XFS Term XFS Term Folder XFS Thesaurus Templates XFS BaseLayout XFS Term XFS Thesaurus Macros XFS-A-ZList XFS-NarrowerTermsBackend XFS-Term XFS-TermList XFS-ThesaurusInfo XFS-ThesaurusName XFS-Title Files /xslt/xuntos/xfs/xfs-a-zlist.xslt /macroscripts//xuntos/xfs.narrowerterms Backend.cshtml /xslt/xuntos/xfs/xfs-term.xslt /xslt/xuntos/xfs/xfs-termlist.xslt /xslt/xuntos/xfs/xfs-thesaurusinfo.xslt /xslt/xuntos/xfs/xfs-thesaurusname.xslt /xslt/xuntos/xfs/xfs-title.xslt /css/xuntos/xfs.backend.css /css/xuntos/xfs.frontend.css /macroscripts/xuntos/xfs.narrowerterms Backend.cshtml /scripts/libs/jquery.autocomplete.js /scripts/xuntos/xfs.backend.jquery-ui custom.min.js /scripts/xuntos/xfs.backend.js /scripts/libs/jquery.autocomplete.js /bin/xuntos.xfs.umb.dll /Umbraco/images/Umbraco/xfs_termfolder.png /Umbraco/images/Umbraco/xfs_thesaurus.png /Umbraco/images/Umbraco/xfs_thesaurusterm.png /Umbraco/webservices/ThesaurusCompleteHandler.ashx /bin/packageactionscontrib.dll Data types Thesaurus Narrower Terms Thesaurus Relation to Term Thesaurus Select Terms - End of installation guide - 8