8000 object/doc/object-types.md at master · apparat/object · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 
193 lines (145 loc) · 6.85 KB

object-types.md

File metadata and controls

193 lines (145 loc) · 6.85 KB

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
  1. 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
  1. 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
  1. 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
  1. Event (event)

  1. 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
  1. 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
  1. 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
  1. Repost (repost)

  • For pure 100% re-publications of another post (e.g. Retweet, Reblogging etc.)
  • Compatible with µf2 h-entry
  • Body file part is mapped to the u-repost-of property
  • See IWC like
  1. 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
  1. 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
  1. Review / recommendation / rating (review)

  • For reviews, recommendations or ratings
  • Compatible with µf2 h-review
  • Body file part is mapped to the e-description property
  1. Venue / address (venue)

  1. 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
  1. Contact card (contact)

  1. Address (address)

  • Postal address
  • Compatible with µf2 h-adr
  • Body file part is mapped to?
  1. 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
  1. 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?
  1. 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
  1. 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
  1. 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
0