Text objects

What follows is a list of supported text based object types.

1. Article (article)

  • For medium to large, episodic and / or timestamped texts
  • Compatible with µf2 h-entry
  • Body file part is mapped to the e-content property
  • See IWC articles

2. Notes (note)

  • For short, typically unstructured and possibly timestamped (plain)texts
  • Compatible with µf2 h-entry
  • Body file part is mapped to the e-content property
  • See IWC notes

3. Comments / replies (reply)

  • Similar to notes, but in reply to another resource which is necessary to know in order to fully understand the reply
  • Compatible with µf2 h-entry
  • Body file part is mapped to the e-content property
  • See IWC notes

4. Code (code)

  • For source code snippets
  • Compatible with µf2 h-entry
  • Body file part is mapped to the e-content property
  • Custom p-language-name and p-language-version properties to denote the programming language and version as hint for syntax highlighters etc.
  • See IWC code

5. Event (event)

6. RSVP (rsvp)

  • Similar to replies, but in response to an event post
  • Compatible with µf2 h-entry
  • Body file part is mapped to the draft p-rsvp property
  • See IWC RSVP

7. Favourite (favourite)

  • For favourites as on Twitter
  • Compatible with µf2 h-entry
  • Body file part is mapped to the u-like-of property
  • See IWC favourite

8. Like (like)

  • For likes like on Facebook, Instagram etc.
  • Compatible with µf2 h-entry
  • Body file part is mapped to the u-like-of property
  • See IWC like

9. Bookmark (bookmark)

  • For bookmarks consisting of a URL, sometimes with a description or cite
  • Compatible with µf2 h-entry
  • Body file part is mapped to the e-content property
  • Special property u-bookmark-of to denote the bookmarked URL
  • See IWC bookmark

10. Checkin (checkin)

  • For venue checkins
  • Compatible with µf2 h-entry
  • Body file part is mapped to?
  • Has a p-location h-card property for setting the venue
  • What about referencing a venue post?
  • See IWC checkin

11. Review / recommendation / rating (review)

  • For reviews, recommendations or ratings
  • Compatible with µf2 h-review
  • Body file part is mapped to the e-description property

12. Venue / address (venue)

13. Geographical coordinates (geo)

  • WGS84 geographic coordinates, typically used by checkins and events
  • Compatible with µf2 h-geo
  • Body file part is mapped to?
  • See IWC location

14. Contact card (contact)

15. Citation (cite)

  • Citation or reference to online publication
  • Compatible with µf2 h-cite
  • Body file part is mapped to the p-content property
  • See IWC citation

16. Project (project)

  • Citation or reference to online publication
  • Compatible with µf2 h-project
  • Body file part is mapped to the e-description property
  • What about a product object type?

17. Item (item)

  • As base for a review, project / product or event (in rare cases)
  • Compatible with µf2 h-item
  • Body file part is mapped to?

Media objects

Media objects consist of two files: The media file and a like-named YAML file containing the meta data. In addition, the meta data might be embedded into the media file in case the file format supports this.

1. Images (image)

  • For photos or images with an optional caption / description
  • Compatible with µf2 h-entry
  • Has a reference to the image file that is mapped to the u-photo property
  • Body file part is mapped to the e-content property (image description)
  • All image formats are allowed
  • See IWC photos

2. Audio (audio)

  • For audio files / sound recordings with an optional caption / description
  • Compatible with µf2 h-entry
  • Has a reference to the audio file that is mapped to the u-audio property
  • Body file part is mapped to the e-content property (audio file description)
  • All audio formats are allowed
  • See IWC audio

3. Video (video)

  • For video files with an optional caption / description
  • Compatible with µf2 h-entry
  • Has a reference to the video file that is mapped to the u-video property
  • Body file part is mapped to the e-content property (audio file description)
  • All video formats are allowed
  • See IWC video

Object properties

Object properties are aggregated into 5 property collections, of which only the first one (system properties) is mandatory:

Property collections

A. System properties

  • UID
  • Type
  • Revision
  • Creation date
  • Publication date
  • Hash

B. Meta properties

  • Keywords
  • Categories
  • Authors
  • Summary

C. Domain properties

Object type dependent properties.

D. Resource relations

Resource relations need to carry the following characteristics:

  • Relation type (active / passive)
  • refers-to / referred-by: Regular links from / to resources (both apparat objects and regular HTTP links)
  • embeds / embedded-by: Inclusive associations like media objects (images, audio, video)
  • replies-to / replied-by: Responses between resources
  • likes / liked-by: Relationships between resources expressing sympathy or approval ("Likes")
  • reposts / reposted-by: Reationships between a resource reposting another resource
  • Relation target
    • local (apparat) URL
    • absolute apparat URL (remote object)
    • arbitrary URL (no apparat object)
  • Coupling
    • Coupled objects (only valid for apparat objects)
    • Loosely coupled

E. Processing instructions

  • Templating variables
  • Miscellaneous rendering instructions
    • Additional styles?
    • JavaScript libraries?

Object hash

A SHA1 hash is used as object checksum. It's generated from normalized versions of

All other properties aren't used for the hash:

  • The system properties contain descriptive properties including the hash that are not related to the objects content.
  • The resource relations are either incoming (which doesn't have any effect on the object) or already covered by the object payload.
  • The processing instructions are serving display purposes only and don't tell anything about the object content.