[DOCU-270] Microformat support in STK Created: 04/Apr/12  Updated: 03/Nov/15

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Ruth Stocks
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: XML File config.modules.standard-templating-kit.dialogs.components.content.stkRecipe.xml     XML File config.modules.standard-templating-kit.templates.components.content.stkRecipe.xml     Microsoft Word recipe-componet-test.docx     XML File website.demo-project.about.recipe.xml    
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Document microformat support in STK. STK adds microformat markup to contacts (hCard) and events (hCalendar) by default. Support for other formats can be added through customization.

Topics to cover:

  • Introduction: What are microformats?
  • How to see the pre-built microformat support in STK?
    1. Install a browser plugin that supports microformats such as Operator for Firefox.
    2. Go to a Web page that provides a microformat such as an event or a contact.
    3. Click a button in the browser plugin to add the event to your calendar or contact to your address book.
  • Microformat attributes in HTML elements. Show the HTML source for a contact or an event. Explain how the semantic microformat class attributes are added to HTML elements, see hCard for an example. Show how the attributes are added in the template scripts (/templating-kit/components/teasers/contact.ftl, /templating-kit/pages/content/event/infoblock.ftl).
  • Customizing
    • Sample events - a recipe for creating events with vCard support. Link to wiki page with a brief summary.
    • Twigs module. Plans to improve and expand support for microformats. See for example MTWIGS-32 and team meeting notes. The module is not yet migrated to 4.5. Link to wiki page with a brief summary.

Resources:



 Comments   
Comment by Ruth Stocks [ 13/Apr/12 ]

Draft page at - http://docuauthor.magnolia-cms.com/templates/microformats.html

Notes:

  • I have not assigned this back to you because I need some help (see below).
  • I didn't use or link to - http://wiki.magnolia-cms.com/display/WIKI/Sample+events page on the wiki mainly because the content seems to be superceded by the stkEvents template. Also it was written prior to 2008 and the code samples are in jsp. I included a section explaining how STK events work.
  • For the customization section, I attempted a new component - Recipe.
  • I have attached my configuration files and a doc named recipe-component-test.docx. This document contains the results of running the component through Google's testing tool. The main problem is my script file. It does work, but I can't figure out how to code the times in ISO 8601 format - http://www.w3.org/TR/xmlschema-2/#duration, and would appreciate some help. From what I have read, it doesn't need to be quite as complicated as the infoblock.ftl script, but I could be wrong. Another problem (with the script?) is using the caption field in the Image tab of the dialog. When I do this, the component disappears from the page?
  • I have not yet linked to or mentioned the Twigs module. I would like to like to install it and perhaps put up an official module page. Any thoughts?
Comment by Ruth Stocks [ 13/Apr/12 ]

Forgot to mention that the image last image in the hCard section does not use the correct arrow. I couldn't find a way to use them. As a result, this image does not match the first image on the page.

Comment by Antti Hietala [ 18/May/12 ]

Article was activated to Microformat support in STK.

I used ISO 8601 format for the duration times. This is not a very user-friendly solution since the times need to entered in minutes and they are rendered in minutes, e.g. 1h 30 min is 90 minutes, but it validates.

Generated at Mon Feb 12 01:07:32 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.