From cd9698a4b65a1f260f49e21d2d82846683da2e4e Mon Sep 17 00:00:00 2001 From: Robert Beeger Date: Wed, 21 May 2014 14:31:57 +0200 Subject: [PATCH 1/4] Added annotation net.bookitics.book.XXXXXX --- annotations/net.bookitics.book.XXXXXX.md | 39 ++++++++++++++++++++++++ annotations/net.bookitics.bookrating.md | 11 ++++--- 2 files changed, 45 insertions(+), 5 deletions(-) create mode 100644 annotations/net.bookitics.book.XXXXXX.md diff --git a/annotations/net.bookitics.book.XXXXXX.md b/annotations/net.bookitics.book.XXXXXX.md new file mode 100644 index 0000000..6a29b14 --- /dev/null +++ b/annotations/net.bookitics.book.XXXXXX.md @@ -0,0 +1,39 @@ + +# Book + + +> ### net.bookitics.book.XXXXXX + + +Identifies the book a post is rating. The Xs are replaced by the id of the first post to rate a book. + +So if the post rates a book that was already rated in the post with the id 4711, the post will have an annotation with the name "net.bookitics.book.4711". The value of the annotation is not relevant. The important thing is that the annotation is present and the post can be found by searching for the annotation. + + +## Example + +~~~ js +{ + "type\": "net.bookitics.book.4711", + "value": {" + "answer": "42", + } +} +~~~ + + +## Fields + +There are no used fields in this annotation. Bookitics generates the field "answer" with the value "42", because an annotation must have a value. + + +## Maintainers +* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) + + +## Used by +* [Bookitics](http://bookitics.net) + + +## Related annotations +* [net.bookitics.bookrating](net.bookitics.bookrating.md) diff --git a/annotations/net.bookitics.bookrating.md b/annotations/net.bookitics.bookrating.md index 521f68c..130bc25 100644 --- a/annotations/net.bookitics.bookrating.md +++ b/annotations/net.bookitics.bookrating.md @@ -7,11 +7,11 @@ Identifies a post as a book rating and contains additional book rating data. -In addition to the annotation described here, book rating posts may contain an attached book cover image which is provided via the standard App.net mechanism using a net.app.core.oembed. +In addition to the annotation described here, book rating posts may contain an attached book cover image which is provided via the standard App.net mechanism using a net.app.core.oembed. Also the standard hashtag mechanism is used to tag book ratings in order to define to which genres the rated books belongs. -As it is currently not possible to search for posts containing specific annotation values, the post text contains the author and title of the book. Book ratings created based on another book rating also contain the book id as a hashtag #bid<book_id>, which allows to find other posts rating the same book. +As it is currently not possible to search for posts containing specific annotation values, the post text contains the author and title of the book. Book ratings created based on another book rating also have a [net.bookitics.book.XXXXXX](net.bookitics.book.XXXXXX.md) annotation. ## Example @@ -44,12 +44,13 @@ As it is currently not possible to search for posts containing specific annotati ## Maintainers -* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) +* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) -## Used by +## Used by * [Bookitics](http://bookitics.net) ## Related annotations -* [net.app.core.oembed.md](https://github.com/appdotnet/object-metadata/blob/master/annotation/net.app.core.oembed.md) \ No newline at end of file +* [net.bookitics.book.XXXXXX](net.bookitics.book.XXXXXX.md) +* [net.app.core.oembed.md](https://github.com/appdotnet/object-metadata/blob/master/annotations/net.app.core.oembed.md) From f446e6576150b3463c7ffb19381cb1f9b60e0784 Mon Sep 17 00:00:00 2001 From: Robert Beeger Date: Wed, 21 May 2014 15:13:48 +0200 Subject: [PATCH 2/4] Added Appiast annotations net.appiast.apprating and net.appiast.app.XXXXXX. --- annotations/net.appiast.app.XXXXXX.md | 41 +++++++++++++++++ annotations/net.appiast.apprating.md | 63 +++++++++++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 annotations/net.appiast.app.XXXXXX.md create mode 100644 annotations/net.appiast.apprating.md diff --git a/annotations/net.appiast.app.XXXXXX.md b/annotations/net.appiast.app.XXXXXX.md new file mode 100644 index 0000000..1753551 --- /dev/null +++ b/annotations/net.appiast.app.XXXXXX.md @@ -0,0 +1,41 @@ + +# App + + +> ### net.appiast.app.XXXXXX + + +Identifies the app a post is rating. The Xs are replaced by the id of the app the post is rating. + +To ensure uniqueness of app ids, they have prefixes that identify them as belonging to a specific app store or other source of apps. Ids from the Apple Mac, iPhone and iPad app stores are prefix with an "a". So a post rating the app "Appiast" which has the id 868774614 will have an annotation with the name "net.appiast.app.a868774614" + +This annotation is used to find all app ratings for a specific app. + + +## Example + +~~~ js +{ + "type\": "net.appiast.app.a868774614", + "value": {" + "answer": "42", + } +} +~~~ + + +## Fields + +There are no used fields in this annotation. Appiast generates the field "answer" with the value "42", because an annotation must have a value. + + +## Maintainers +* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) + + +## Used by +* [Appiast](http://appiast.net) + + +## Related annotations +* [net.appiast.apprating](net.appiast.apprating.md) diff --git a/annotations/net.appiast.apprating.md b/annotations/net.appiast.apprating.md new file mode 100644 index 0000000..c31e8f9 --- /dev/null +++ b/annotations/net.appiast.apprating.md @@ -0,0 +1,63 @@ + +# App rating + + +> ### net.appiast.apprating + + +Identifies a post as an app rating and contains additional app rating data. + +In addition to the annotation described here, app rating posts contain an attached app icon image which is provided via the standard App.net mechanism using a net.app.core.oembed. + +Also the standard hashtag mechanism is used to tag app ratings in order to define what kind of app the rated app is. + +The post text contains + * the name of the app which is also a link to the app in the app store + * As much of the app review as fits into the post + * Five stars that reflect the rating of the app by being filled or empty (e.g. ★★★☆☆) which is also a link to appiast.net showing the full text of the review + * The tags given by the user + +Each app rating post also has a [net.appiast.app.XXXXXX](net.appiast.app.XXXXXX.md) annotation. + + +## Example + +~~~ js +{ + "type":"net.appiast.apprating", + "value":{ + "app_name":"Appiast", + "app_type":"iOS", + "review":"Appiast is an app for writing and finding reviews of other apps. Reviews ...", + "full_review_url":"", + "rating":5, + "app_id":"868774614" + } +} +~~~ + + +## Fields + +| Field | Required? | Type | Description | +| ----- | --------- | ---- | ----------- | +| `app_name` | Required | string | The name of the app | +| `app_type` | Required | string | The type of the app. Currently there are "iOS" and "Mac" | +| `rating` | Required | integer | A rating of the app between 1 (lowest) and 5 (highest). | +| `review` | Optional | string | A short review of the app.| +| `full_review_url` | Optional | string | The URL of a longer review of the app | +| `app_id` | Optional | string | The id of the rated app in the specific app store or other source of apps. | + + + +## Maintainers +* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) + + +## Used by +* [Appiast](http://appiast.net) + + +## Related annotations +* [net.appiast.app.XXXXXX](net.appiast.app.XXXXXX.md) +* [net.app.core.oembed.md](https://github.com/appdotnet/object-metadata/blob/master/annotations/net.app.core.oembed.md) From 60e6e083e12883031ceea65a7e4e7dcd7c3c709d Mon Sep 17 00:00:00 2001 From: Robert Beeger Date: Wed, 21 May 2014 15:17:52 +0200 Subject: [PATCH 3/4] Fixed a typo --- annotations/net.appiast.app.XXXXXX.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/annotations/net.appiast.app.XXXXXX.md b/annotations/net.appiast.app.XXXXXX.md index 1753551..6409c56 100644 --- a/annotations/net.appiast.app.XXXXXX.md +++ b/annotations/net.appiast.app.XXXXXX.md @@ -7,7 +7,7 @@ Identifies the app a post is rating. The Xs are replaced by the id of the app the post is rating. -To ensure uniqueness of app ids, they have prefixes that identify them as belonging to a specific app store or other source of apps. Ids from the Apple Mac, iPhone and iPad app stores are prefix with an "a". So a post rating the app "Appiast" which has the id 868774614 will have an annotation with the name "net.appiast.app.a868774614" +To ensure uniqueness of app ids, they have prefixes that identify them as belonging to a specific app store or other source of apps. Ids from the Apple Mac, iPhone and iPad app stores are prefixed with an "a". So a post rating the app "Appiast" which has the id 868774614 will have an annotation with the name "net.appiast.app.a868774614" This annotation is used to find all app ratings for a specific app. From c48b92f2cf02da14e37d34c042e882c2fbfbef02 Mon Sep 17 00:00:00 2001 From: Robert Beeger Date: Sun, 22 Jun 2014 12:56:28 +0200 Subject: [PATCH 4/4] * Removed annotations net.appiast.app.XXXXXX and net.bookitics.book.XXXXXX * Updated documentation of net.appiast.apprating and net.bookitics.bookrating to match the current state. --- annotations/net.appiast.app.XXXXXX.md | 41 ------------------------ annotations/net.appiast.apprating.md | 12 +++---- annotations/net.bookitics.book.XXXXXX.md | 39 ---------------------- annotations/net.bookitics.bookrating.md | 8 +++-- 4 files changed, 11 insertions(+), 89 deletions(-) delete mode 100644 annotations/net.appiast.app.XXXXXX.md delete mode 100644 annotations/net.bookitics.book.XXXXXX.md diff --git a/annotations/net.appiast.app.XXXXXX.md b/annotations/net.appiast.app.XXXXXX.md deleted file mode 100644 index 6409c56..0000000 --- a/annotations/net.appiast.app.XXXXXX.md +++ /dev/null @@ -1,41 +0,0 @@ - -# App - - -> ### net.appiast.app.XXXXXX - - -Identifies the app a post is rating. The Xs are replaced by the id of the app the post is rating. - -To ensure uniqueness of app ids, they have prefixes that identify them as belonging to a specific app store or other source of apps. Ids from the Apple Mac, iPhone and iPad app stores are prefixed with an "a". So a post rating the app "Appiast" which has the id 868774614 will have an annotation with the name "net.appiast.app.a868774614" - -This annotation is used to find all app ratings for a specific app. - - -## Example - -~~~ js -{ - "type\": "net.appiast.app.a868774614", - "value": {" - "answer": "42", - } -} -~~~ - - -## Fields - -There are no used fields in this annotation. Appiast generates the field "answer" with the value "42", because an annotation must have a value. - - -## Maintainers -* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) - - -## Used by -* [Appiast](http://appiast.net) - - -## Related annotations -* [net.appiast.apprating](net.appiast.apprating.md) diff --git a/annotations/net.appiast.apprating.md b/annotations/net.appiast.apprating.md index c31e8f9..f97d8ab 100644 --- a/annotations/net.appiast.apprating.md +++ b/annotations/net.appiast.apprating.md @@ -7,18 +7,18 @@ Identifies a post as an app rating and contains additional app rating data. -In addition to the annotation described here, app rating posts contain an attached app icon image which is provided via the standard App.net mechanism using a net.app.core.oembed. +In addition to the annotation described here, app rating posts contain an attached app icon image which is provided via the standard App.net mechanism using a net.app.core.attachments for Appiast 1.1.0 and up or a net.app.core.oembed for Appiast 1.0.0. + +Posts created by Appiast 1.0.0 contain an additional net.appiast.app.XXXX annotation that was used to find ratings for the same app. This annotation isn't used anymore as it created a new annotation for each app which could eventually have negative effects on the performance of app.net. Instead of this annotation Appiast 1.1.0 and newer use the iTunes App Store URL to which the app name in an Appiast post links to find ratings of the same app. Also the standard hashtag mechanism is used to tag app ratings in order to define what kind of app the rated app is. The post text contains * the name of the app which is also a link to the app in the app store - * As much of the app review as fits into the post + * As much of the first paragraph of the app review as fits into the post * Five stars that reflect the rating of the app by being filled or empty (e.g. ★★★☆☆) which is also a link to appiast.net showing the full text of the review * The tags given by the user -Each app rating post also has a [net.appiast.app.XXXXXX](net.appiast.app.XXXXXX.md) annotation. - ## Example @@ -59,5 +59,5 @@ Each app rating post also has a [net.appiast.app.XXXXXX](net.appiast.app.XXXXXX. ## Related annotations -* [net.appiast.app.XXXXXX](net.appiast.app.XXXXXX.md) -* [net.app.core.oembed.md](https://github.com/appdotnet/object-metadata/blob/master/annotations/net.app.core.oembed.md) +* [net.app.core.oembed.md](net.app.core.oembed.md) +* [net.app.core.attachments.md](net.app.core.attachments.md) diff --git a/annotations/net.bookitics.book.XXXXXX.md b/annotations/net.bookitics.book.XXXXXX.md deleted file mode 100644 index 6a29b14..0000000 --- a/annotations/net.bookitics.book.XXXXXX.md +++ /dev/null @@ -1,39 +0,0 @@ - -# Book - - -> ### net.bookitics.book.XXXXXX - - -Identifies the book a post is rating. The Xs are replaced by the id of the first post to rate a book. - -So if the post rates a book that was already rated in the post with the id 4711, the post will have an annotation with the name "net.bookitics.book.4711". The value of the annotation is not relevant. The important thing is that the annotation is present and the post can be found by searching for the annotation. - - -## Example - -~~~ js -{ - "type\": "net.bookitics.book.4711", - "value": {" - "answer": "42", - } -} -~~~ - - -## Fields - -There are no used fields in this annotation. Bookitics generates the field "answer" with the value "42", because an annotation must have a value. - - -## Maintainers -* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) - - -## Used by -* [Bookitics](http://bookitics.net) - - -## Related annotations -* [net.bookitics.bookrating](net.bookitics.bookrating.md) diff --git a/annotations/net.bookitics.bookrating.md b/annotations/net.bookitics.bookrating.md index 130bc25..a15bef8 100644 --- a/annotations/net.bookitics.bookrating.md +++ b/annotations/net.bookitics.bookrating.md @@ -11,7 +11,11 @@ In addition to the annotation described here, book rating posts may contain an a Also the standard hashtag mechanism is used to tag book ratings in order to define to which genres the rated books belongs. -As it is currently not possible to search for posts containing specific annotation values, the post text contains the author and title of the book. Book ratings created based on another book rating also have a [net.bookitics.book.XXXXXX](net.bookitics.book.XXXXXX.md) annotation. +The post text contains: + * As much of the author and title of the book as fits into the post text + * As much of the first paragraph of the review as fits into the post text + * Five stars that reflect the rating of the app by being filled or empty (e.g. ★★★☆☆) which is also a link to bookitics.net showing the full text of the review + * The tags given by the user ## Example @@ -39,7 +43,6 @@ As it is currently not possible to search for posts containing specific annotati | `rating` | Required | integer | A rating of the book between 1 (lowest) and 5 (highest). | | `short_review` | Optional | string | A short review of the book.| | `full_review_url` | Optional | string | The URL of a longer review of the book | -| `book_id` | Optional | string | The id of the rated book. This is the post id of the post which is the first rating of the book. If not present, the book rating becomes the book defining rating for any book rating based on it. | @@ -52,5 +55,4 @@ As it is currently not possible to search for posts containing specific annotati ## Related annotations -* [net.bookitics.book.XXXXXX](net.bookitics.book.XXXXXX.md) * [net.app.core.oembed.md](https://github.com/appdotnet/object-metadata/blob/master/annotations/net.app.core.oembed.md)