{"action":"created","comment":{"url":"https://api.github.com/repos/Financial-Times/o-ads/pulls/comments/57685666","id":57685666,"diff_hunk":"@@ -0,0 +1,312 @@\n+# Full slot configuration reference\n+Each slot can be configured in a number of ways. Following is a full reference of all the possible configuration parameters.\n+Also each slot can be configured either via JSON configuration object or via the DOM data attributes.\n+\n+***Note:*** the basic configuration such as DFP site and zone need to be configured via the config object, the rest of parameters can be configured on the slot level.\n+\n+## Example\n+\n+### JSON object\n+```js\n+{\n+  key: 'value'\n+}\n+```\n+\n+### DOM data attribute\n+```html\n+<div data-o-ads-key=\"value\"></div>\n+```\n+\n+## Configuration parameters\n+\n+### Targeting\n+Key value pairs for advert targeting, separated by semicolon. No default value.\n+\n+#### JSON Configuration\n+```js\n+{\n+  ...\n+  targeting: 'key=value;key2=value2;'\n+  ...\n+}\n+```\n+\n+#### DOM Configuration\n+```html\n+<div data-o-ads-targeting=\"key=value;key2=value2;\"></div>\n+```\n+\n+---------------------------------------\n+\n+### Sizes\n+Configuration for slot advert sizes. You can define multiple, all will be sent to the advertising server to serve one that matches. No default value.\n+\n+#### JSON Configuration\n+```js\n+{\n+  ...\n+  sizes: [[970, 90], [970, 66], [180, 50]]\n+  ...\n+}\n+```\n+\n+#### DOM Configuration\n+```html\n+<div data-o-ads-sizes=\"970x90,970x66,180x50\"></div>\n+```\n+\n+---------------------------------------\n+\n+### Center\n+Defines if the advert container should be centered on the page. Default is `false`.\n+\n+#### JSON Configuration\n+```js\n+{\n+  ...\n+  center: true\n+  ...\n+}\n+```\n+\n+#### DOM Configuration\n+```html\n+<div data-o-ads-center=\"true\"></div>\n+```\n+\n+---------------------------------------\n+\n+### Label\n+Defines if an \"Advertising\" label should be shown above the slot container and the position of that label. Default is `false`.\n+\n+#### JSON Configuration\n+```js\n+{\n+  ...\n+  label: false\n+  ...\n+}\n+{\n+  ...\n+  label: true\n+  ...\n+}\n+{\n+  ...\n+  label: 'left'\n+  ...\n+}\n+{\n+  ...\n+  label: 'right'\n+  ...\n+}\n+```\n+\n+#### DOM Configuration\n+```html\n+<div data-o-ads-label=\"false\"></div>\n+<div data-o-ads-label=\"true\"></div>\n+<div data-o-ads-label=\"left\"></div>\n+<div data-o-ads-label=\"right\"></div>\n+```\n+\n+---------------------------------------\n+\n+### Out of page\n+Define the parameter if the slot to be requested should be out of page one. Default is `false`.","path":"docs/SLOT_CONFIG_REFERENCE.md","position":118,"original_position":118,"commit_id":"d2b8eb18676f99ef52aed62e2d7e27785793bfd8","original_commit_id":"d2b8eb18676f99ef52aed62e2d7e27785793bfd8","user":{"login":"adgad","id":1978880,"avatar_url":"https://avatars.githubusercontent.com/u/1978880?v=3","gravatar_id":"","url":"https://api.github.com/users/adgad","html_url":"https://github.com/adgad","followers_url":"https://api.github.com/users/adgad/followers","following_url":"https://api.github.com/users/adgad/following{/other_user}","gists_url":"https://api.github.com/users/adgad/gists{/gist_id}","starred_url":"https://api.github.com/users/adgad/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adgad/subscriptions","organizations_url":"https://api.github.com/users/adgad/orgs","repos_url":"https://api.github.com/users/adgad/repos","events_url":"https://api.github.com/users/adgad/events{/privacy}","received_events_url":"https://api.github.com/users/adgad/received_events","type":"User","site_admin":false},"body":"Maybe worth a line saying what an out of page slot is.","created_at":"2016-03-29T08:10:27Z","updated_at":"2016-03-29T08:10:27Z","html_url":"https://github.com/Financial-Times/o-ads/pull/12#discussion_r57685666","pull_request_url":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12","_links":{"self":{"href":"https://api.github.com/repos/Financial-Times/o-ads/pulls/comments/57685666"},"html":{"href":"https://github.com/Financial-Times/o-ads/pull/12#discussion_r57685666"},"pull_request":{"href":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12"}}},"pull_request":{"url":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12","id":64334830,"html_url":"https://github.com/Financial-Times/o-ads/pull/12","diff_url":"https://github.com/Financial-Times/o-ads/pull/12.diff","patch_url":"https://github.com/Financial-Times/o-ads/pull/12.patch","issue_url":"https://api.github.com/repos/Financial-Times/o-ads/issues/12","number":12,"state":"open","locked":false,"title":"Documentation and examples","user":{"login":"VladDubrovskis","id":15323495,"avatar_url":"https://avatars.githubusercontent.com/u/15323495?v=3","gravatar_id":"","url":"https://api.github.com/users/VladDubrovskis","html_url":"https://github.com/VladDubrovskis","followers_url":"https://api.github.com/users/VladDubrovskis/followers","following_url":"https://api.github.com/users/VladDubrovskis/following{/other_user}","gists_url":"https://api.github.com/users/VladDubrovskis/gists{/gist_id}","starred_url":"https://api.github.com/users/VladDubrovskis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/VladDubrovskis/subscriptions","organizations_url":"https://api.github.com/users/VladDubrovskis/orgs","repos_url":"https://api.github.com/users/VladDubrovskis/repos","events_url":"https://api.github.com/users/VladDubrovskis/events{/privacy}","received_events_url":"https://api.github.com/users/VladDubrovskis/received_events","type":"User","site_admin":false},"body":"/cc @adgad @andrewgeorgiou1981 \r\n\r\nUpdated docs to clarify how to initialise the library as well as a more detailed reference to possible slot / library configurations.\r\n\r\nHave a look and let me know if anything is missing or something is unclear.\r\n\r\nAlso please verify the details about the responsive sizes and formats are correct.","created_at":"2016-03-28T15:40:23Z","updated_at":"2016-03-29T08:10:27Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c074e6dcef29bf37a5065c6e661115c8d5c14cbd","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12/commits","review_comments_url":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12/comments","review_comment_url":"https://api.github.com/repos/Financial-Times/o-ads/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Financial-Times/o-ads/issues/12/comments","statuses_url":"https://api.github.com/repos/Financial-Times/o-ads/statuses/d2b8eb18676f99ef52aed62e2d7e27785793bfd8","head":{"label":"Financial-Times:documentation-and-examples","ref":"documentation-and-examples","sha":"d2b8eb18676f99ef52aed62e2d7e27785793bfd8","user":{"login":"Financial-Times","id":3502508,"avatar_url":"https://avatars.githubusercontent.com/u/3502508?v=3","gravatar_id":"","url":"https://api.github.com/users/Financial-Times","html_url":"https://github.com/Financial-Times","followers_url":"https://api.github.com/users/Financial-Times/followers","following_url":"https://api.github.com/users/Financial-Times/following{/other_user}","gists_url":"https://api.github.com/users/Financial-Times/gists{/gist_id}","starred_url":"https://api.github.com/users/Financial-Times/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Financial-Times/subscriptions","organizations_url":"https://api.github.com/users/Financial-Times/orgs","repos_url":"https://api.github.com/users/Financial-Times/repos","events_url":"https://api.github.com/users/Financial-Times/events{/privacy}","received_events_url":"https://api.github.com/users/Financial-Times/received_events","type":"Organization","site_admin":false},"repo":{"id":29254513,"name":"o-ads","full_name":"Financial-Times/o-ads","owner":{"login":"Financial-Times","id":3502508,"avatar_url":"https://avatars.githubusercontent.com/u/3502508?v=3","gravatar_id":"","url":"https://api.github.com/users/Financial-Times","html_url":"https://github.com/Financial-Times","followers_url":"https://api.github.com/users/Financial-Times/followers","following_url":"https://api.github.com/users/Financial-Times/following{/other_user}","gists_url":"https://api.github.com/users/Financial-Times/gists{/gist_id}","starred_url":"https://api.github.com/users/Financial-Times/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Financial-Times/subscriptions","organizations_url":"https://api.github.com/users/Financial-Times/orgs","repos_url":"https://api.github.com/users/Financial-Times/repos","events_url":"https://api.github.com/users/Financial-Times/events{/privacy}","received_events_url":"https://api.github.com/users/Financial-Times/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Financial-Times/o-ads","description":"Advertising framework for DFP","fork":false,"url":"https://api.github.com/repos/Financial-Times/o-ads","forks_url":"https://api.github.com/repos/Financial-Times/o-ads/forks","keys_url":"https://api.github.com/repos/Financial-Times/o-ads/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Financial-Times/o-ads/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Financial-Times/o-ads/teams","hooks_url":"https://api.github.com/repos/Financial-Times/o-ads/hooks","issue_events_url":"https://api.github.com/repos/Financial-Times/o-ads/issues/events{/number}","events_url":"https://api.github.com/repos/Financial-Times/o-ads/events","assignees_url":"https://api.github.com/repos/Financial-Times/o-ads/assignees{/user}","branches_url":"https://api.github.com/repos/Financial-Times/o-ads/branches{/branch}","tags_url":"https://api.github.com/repos/Financial-Times/o-ads/tags","blobs_url":"https://api.github.com/repos/Financial-Times/o-ads/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Financial-Times/o-ads/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Financial-Times/o-ads/git/refs{/sha}","trees_url":"https://api.github.com/repos/Financial-Times/o-ads/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Financial-Times/o-ads/statuses/{sha}","languages_url":"https://api.github.com/repos/Financial-Times/o-ads/languages","stargazers_url":"https://api.github.com/repos/Financial-Times/o-ads/stargazers","contributors_url":"https://api.github.com/repos/Financial-Times/o-ads/contributors","subscribers_url":"https://api.github.com/repos/Financial-Times/o-ads/subscribers","subscription_url":"https://api.github.com/repos/Financial-Times/o-ads/subscription","commits_url":"https://api.github.com/repos/Financial-Times/o-ads/commits{/sha}","git_commits_url":"https://api.github.com/repos/Financial-Times/o-ads/git/commits{/sha}","comments_url":"https://api.github.com/repos/Financial-Times/o-ads/comments{/number}","issue_comment_url":"https://api.github.com/repos/Financial-Times/o-ads/issues/comments{/number}","contents_url":"https://api.github.com/repos/Financial-Times/o-ads/contents/{+path}","compare_url":"https://api.github.com/repos/Financial-Times/o-ads/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Financial-Times/o-ads/merges","archive_url":"https://api.github.com/repos/Financial-Times/o-ads/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Financial-Times/o-ads/downloads","issues_url":"https://api.github.com/repos/Financial-Times/o-ads/issues{/number}","pulls_url":"https://api.github.com/repos/Financial-Times/o-ads/pulls{/number}","milestones_url":"https://api.github.com/repos/Financial-Times/o-ads/milestones{/number}","notifications_url":"https://api.github.com/repos/Financial-Times/o-ads/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Financial-Times/o-ads/labels{/name}","releases_url":"https://api.github.com/repos/Financial-Times/o-ads/releases{/id}","deployments_url":"https://api.github.com/repos/Financial-Times/o-ads/deployments","created_at":"2015-01-14T16:46:25Z","updated_at":"2016-02-23T23:05:29Z","pushed_at":"2016-03-28T15:42:35Z","git_url":"git://github.com/Financial-Times/o-ads.git","ssh_url":"git@github.com:Financial-Times/o-ads.git","clone_url":"https://github.com/Financial-Times/o-ads.git","svn_url":"https://github.com/Financial-Times/o-ads","homepage":"http://registry.origami.ft.com/components/o-ads","size":4223,"stargazers_count":4,"watchers_count":4,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":5,"forks":2,"open_issues":5,"watchers":4,"default_branch":"master"}},"base":{"label":"Financial-Times:master","ref":"master","sha":"202911e0d960abadf122626e9cb8f38376075196","user":{"login":"Financial-Times","id":3502508,"avatar_url":"https://avatars.githubusercontent.com/u/3502508?v=3","gravatar_id":"","url":"https://api.github.com/users/Financial-Times","html_url":"https://github.com/Financial-Times","followers_url":"https://api.github.com/users/Financial-Times/followers","following_url":"https://api.github.com/users/Financial-Times/following{/other_user}","gists_url":"https://api.github.com/users/Financial-Times/gists{/gist_id}","starred_url":"https://api.github.com/users/Financial-Times/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Financial-Times/subscriptions","organizations_url":"https://api.github.com/users/Financial-Times/orgs","repos_url":"https://api.github.com/users/Financial-Times/repos","events_url":"https://api.github.com/users/Financial-Times/events{/privacy}","received_events_url":"https://api.github.com/users/Financial-Times/received_events","type":"Organization","site_admin":false},"repo":{"id":29254513,"name":"o-ads","full_name":"Financial-Times/o-ads","owner":{"login":"Financial-Times","id":3502508,"avatar_url":"https://avatars.githubusercontent.com/u/3502508?v=3","gravatar_id":"","url":"https://api.github.com/users/Financial-Times","html_url":"https://github.com/Financial-Times","followers_url":"https://api.github.com/users/Financial-Times/followers","following_url":"https://api.github.com/users/Financial-Times/following{/other_user}","gists_url":"https://api.github.com/users/Financial-Times/gists{/gist_id}","starred_url":"https://api.github.com/users/Financial-Times/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Financial-Times/subscriptions","organizations_url":"https://api.github.com/users/Financial-Times/orgs","repos_url":"https://api.github.com/users/Financial-Times/repos","events_url":"https://api.github.com/users/Financial-Times/events{/privacy}","received_events_url":"https://api.github.com/users/Financial-Times/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Financial-Times/o-ads","description":"Advertising framework for DFP","fork":false,"url":"https://api.github.com/repos/Financial-Times/o-ads","forks_url":"https://api.github.com/repos/Financial-Times/o-ads/forks","keys_url":"https://api.github.com/repos/Financial-Times/o-ads/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Financial-Times/o-ads/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Financial-Times/o-ads/teams","hooks_url":"https://api.github.com/repos/Financial-Times/o-ads/hooks","issue_events_url":"https://api.github.com/repos/Financial-Times/o-ads/issues/events{/number}","events_url":"https://api.github.com/repos/Financial-Times/o-ads/events","assignees_url":"https://api.github.com/repos/Financial-Times/o-ads/assignees{/user}","branches_url":"https://api.github.com/repos/Financial-Times/o-ads/branches{/branch}","tags_url":"https://api.github.com/repos/Financial-Times/o-ads/tags","blobs_url":"https://api.github.com/repos/Financial-Times/o-ads/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Financial-Times/o-ads/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Financial-Times/o-ads/git/refs{/sha}","trees_url":"https://api.github.com/repos/Financial-Times/o-ads/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Financial-Times/o-ads/statuses/{sha}","languages_url":"https://api.github.com/repos/Financial-Times/o-ads/languages","stargazers_url":"https://api.github.com/repos/Financial-Times/o-ads/stargazers","contributors_url":"https://api.github.com/repos/Financial-Times/o-ads/contributors","subscribers_url":"https://api.github.com/repos/Financial-Times/o-ads/subscribers","subscription_url":"https://api.github.com/repos/Financial-Times/o-ads/subscription","commits_url":"https://api.github.com/repos/Financial-Times/o-ads/commits{/sha}","git_commits_url":"https://api.github.com/repos/Financial-Times/o-ads/git/commits{/sha}","comments_url":"https://api.github.com/repos/Financial-Times/o-ads/comments{/number}","issue_comment_url":"https://api.github.com/repos/Financial-Times/o-ads/issues/comments{/number}","contents_url":"https://api.github.com/repos/Financial-Times/o-ads/contents/{+path}","compare_url":"https://api.github.com/repos/Financial-Times/o-ads/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Financial-Times/o-ads/merges","archive_url":"https://api.github.com/repos/Financial-Times/o-ads/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Financial-Times/o-ads/downloads","issues_url":"https://api.github.com/repos/Financial-Times/o-ads/issues{/number}","pulls_url":"https://api.github.com/repos/Financial-Times/o-ads/pulls{/number}","milestones_url":"https://api.github.com/repos/Financial-Times/o-ads/milestones{/number}","notifications_url":"https://api.github.com/repos/Financial-Times/o-ads/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Financial-Times/o-ads/labels{/name}","releases_url":"https://api.github.com/repos/Financial-Times/o-ads/releases{/id}","deployments_url":"https://api.github.com/repos/Financial-Times/o-ads/deployments","created_at":"2015-01-14T16:46:25Z","updated_at":"2016-02-23T23:05:29Z","pushed_at":"2016-03-28T15:42:35Z","git_url":"git://github.com/Financial-Times/o-ads.git","ssh_url":"git@github.com:Financial-Times/o-ads.git","clone_url":"https://github.com/Financial-Times/o-ads.git","svn_url":"https://github.com/Financial-Times/o-ads","homepage":"http://registry.origami.ft.com/components/o-ads","size":4223,"stargazers_count":4,"watchers_count":4,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":5,"forks":2,"open_issues":5,"watchers":4,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12"},"html":{"href":"https://github.com/Financial-Times/o-ads/pull/12"},"issue":{"href":"https://api.github.com/repos/Financial-Times/o-ads/issues/12"},"comments":{"href":"https://api.github.com/repos/Financial-Times/o-ads/issues/12/comments"},"review_comments":{"href":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12/comments"},"review_comment":{"href":"https://api.github.com/repos/Financial-Times/o-ads/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Financial-Times/o-ads/pulls/12/commits"},"statuses":{"href":"https://api.github.com/repos/Financial-Times/o-ads/statuses/d2b8eb18676f99ef52aed62e2d7e27785793bfd8"}}}}