Show navigation ≫
≪ Hide navigation
Structure > Source File

Definition

A Connected Web Source File is a JSON or JSONP encoded file which contains the information of the source of a Feed file. Hence it always requires to be linked from a Feed file.

It's necessary to deliver more accurate information about the source of a Feed file.

File structure

Optional parameters are indicated as "(Optional)"

Parameter Meaning Notes
type (string) The type of file.
  • Must be source
cwversion (float) The version of the Connected Web format.
  • It helps a file parser to understand with which version of the Connected Web format should be this file parsed.
name (string) The name of the source.
  • Keep it shorter than 55 characters. If longer, some platforms will cut it.
description (string) (optional) The description of the source.
  • This value will help platforms to understand better which kind of contents your source is producing.
  • It's suggested to keep it shorter than 160 characters. If longer, some Connected Web parsers will cut it.
keywords (array) (optional) A list of keywords which identifies the source.
  • This value will help platforms to understand better which kind of contents the source is producing.
  • It's suggested to set no more than 5 tags, otherwise some Connected Web parsers will exclude the remaining ones.
url (string) (optional) The url of the homepage of the source.
  • Only public http or https urls are supported.
language (string) The language of the source.
  • Must meet ISO 639-1 standardized nomenclature.
img (image_object) (optional) The logo / image of the source.
  • This parameter requires a Connected Web Image Object. See the Object > Image documentation for more.
  • It's suggested a minimum resolution of 2000x2000px.
cover (image_object) (optional) The cover image of the source.
  • This parameter requires a Connected Web Image Object. See the Object > Image documentation for more.
  • It's suggested a minimum resolution of 2000x2000px.
Understand the Feed file

Example

{

    "type": "source",
    "cwversion": 1.1,
    "name": "ConnectedWeb",
    "description": "Connected Web is a web syndication format focused on high quality and cross device content sharing.",
    "keywords": "connected, web, feed, rss, atom, syndication, format",
    "url": "http://showcase.connectedweb.org",
    "img": {
    
    	"url": "http://fbwcdn.com/image/main/connectedweb/logo.jpg",
        "width": 2000,
        "height": 2000,
        "type": "image/jpeg"
    
    },
	"cover": {
    
    	"url": "http://fbwcdn.com/image/main/connectedweb/cover.jpg",
        "width": 2000,
        "height": 2000,
        "type": "image/jpeg"
    
    }

}
Show navigation ≫
≪ Hide navigation