bonustrack / steemscript Goto Github PK

I feel like there should be a guideline for using the comment metadata, similar to the one for the account information.

Eg, it's not clear what "app" should be used for - some new Steem apps have been talking about using it as a filter rather than solely as the user agent indicator as I believe it's intended for.. but I wouldn't know, because there's no guidelines ;)

We will need further standards/guidelines for what each field should contain.

Some ideas to get started:

• maximum field lengths

  • account.json_metadata.profile.name (twitter: 20 chars)
  • account.json_metadata.profile.about (twitter: 160 chars)
  • account.json_metadata.profile.location (twitter: 30 chars)
  • account.json_metadata.profile.website (twitter: 100 chars)

• image dimensions/aspect ratios

  • account.json_metadata.profile.profile_image
    • profile images should be assumed to be square-cropped
    • optimal minimum size (230x230px?)
    • should be a valid URL, at minimum matching ^https?:\/\/

If we have account.json_metadata.profile.name do we need first_name and last_name?

The v1.0.2 tag doesn't include the version bump commit.

The current specification has a dedicated field for images and video. This does not allow room for other forms of media, or future forms of media. I would recommend using a media[] field with entries that are [{ "url": "http://url.to.media" , "type": "image"}, { "url": "http://url.to.media" , "type": "video"}, { "url": "http://url.to.media" , "type": "audio"}, etc...]

{
    "app": "steemit/1.23",
    "format": "html",
    "tags": ["steemit", "steem"],
    "users": ["ned", "dan"],
    "media": [{ "url": "http://url.to.media" , "type": "image"}, { "url": "http://url.to.media" , "type": 
                    "video"}, { "url": "http://url.to.media" , "type": "audio"}, etc...],
    "status": "archived",
    "canonical": "http://blog.steem.io/steem/@ned/the-first-phase-of-the-steem-faq-and-wikee-consolidation-of-knowledge"
}

As more apps like Zappl and Steepshot start building on top of the Steem blockchain, scenarios are becoming apparent where where there's a need to begin filtering content based on the app it was intended for. Eg, it makes sense for micro-content from Zappl (A small photo with caption, a short microblog/tweet) to only appear in Zappl, and not to appear on Steemit.com

Currently, there's nothing inside the standard, specifically relating to comment metadata that is identified to be used in this manner and so I'm proposing that the standard be amended to facilitate this

Specifically, I recommend the addition of two fields to the comment metadata for the standard:

1. ecosystem: Multi-value field to indicate which apps the comment should be read by. If no value is provided, 'steemit' will be the assumed default (which will make this backwards compatible with the existing comments in the blockchain).

2. appkey: This will be a public key that an app can use to verify whether comments posted to its content ecosystem should be filtered into the app. The authentication mechanism is up to the target app, but the posting app will only ever need to provide a single key with each comment (this single key should be accepted for any ecosystem it's posting to).

The timing seems crucial on this, as we're getting very close to a point where apps will begin posting large volumes of content on the Steem blockchain (Steepshot in Alpha now, Zappl beta in August '17) and if no standard is established we'll have complete and utter mayhem ;)