pages/metadata.md - Issue 29680647: Issue 5329 - Provide a template for social media meta data in website-defaults

Delta Between Two Patch Sets: pages/metadata.md

Issue 29680647: Issue 5329 - Provide a template for social media meta data in website-defaults (Closed) Base URL: https://hg.adblockplus.org/website-defaults

Left Patch Set: Created Jan. 26, 2018, 11:28 a.m.

Right Patch Set: Addressed NITs Created Feb. 1, 2018, 9:06 a.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 title=Metadata	1 title=Metadata
ire 2018/01/26 11:33:59 I added this page because 1) I think it's easier t I added this page because 1) I think it's easier to understand what goes into this particular feature when the variables are abstracted from the code and 2) I think we should try and document our features more in general juliandoucette 2018/01/30 04:04:41 Acknowledged. Show quoted text On 2018/01/26 11:33:59, ire wrote: > I added this page because 1) I think it's easier to understand what goes into > this particular feature when the variables are abstracted from the code and 2) I > think we should try and document our features more in general Acknowledged.
2 description=Default metadata for eyeo websites	2 description=Default metadata for eyeo websites

3

4 <head>

5 <style>

6 code { font-family: monospace; }
ire 2018/01/26 11:33:59 This could/should be in website-defaults. If you a This could/should be in website-defaults. If you agree I can add it separately but, since it's only being used in this page, I'm also fine with leaving this here juliandoucette 2018/01/30 04:04:41 NIT: Please add it separately and remove the head Show quoted text On 2018/01/26 11:33:59, ire wrote: > This could/should be in website-defaults. If you agree I can add it separately > but, since it's only being used in this page, I'm also fine with leaving this > here NIT: Please add it separately and remove the head block from templates/minimal (in this patchset at least). ire 2018/01/30 08:19:10 https://codereview.adblockplus.org/29684561 Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > On 2018/01/26 11:33:59, ire wrote: > > This could/should be in website-defaults. If you agree I can add it separately > > but, since it's only being used in this page, I'm also fine with leaving this > > here > > NIT: Please add it separately and remove the head block from templates/minimal > (in this patchset at least). https://codereview.adblockplus.org/29684561
7 </style>

8 </head>

9	3

10 # Metadata	4 # Metadata

11	5

12 Default metadata for eyeo websites	6 Default metadata for eyeo websites

13	7

14 1. [Social metadata](#social)	8 1. [Social metadata](#social)

15	9

16 ## Social metadata { #social }	10 ## Social metadata { #social }

17	11

18 ### Local variables	12 ### Local properties

19	13

20 The following variables can be set on a per page basis:	14 The following page properties can be set on a per page basis:
juliandoucette 2018/01/30 04:04:41 NIT: Perhaps we should mention where/how they can NIT: Perhaps we should mention where/how they can be set e.g. via page meta data or {% set %}. (I would tend to call these "properties of a page" because they are usually defined in page front matter. Although variables may be more technically correct.) ire 2018/01/30 08:19:09 I think this is more global "how to use the cms" i Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > NIT: Perhaps we should mention where/how they can be set e.g. via page meta data > or {% set %}. I think this is more global "how to use the cms" information, rather than specific to this include. Show quoted text > (I would tend to call these "properties of a page" because they are usually > defined in page front matter. Although variables may be more technically > correct.) Changed.
21	15

22 - `og_url`	16 - `og_url`

23 - `og_type`	17 - `og_type`

24 - `og_site_name`	18 - `og_site_name`
juliandoucette 2018/01/30 04:04:41 NIT: Should not be page specific. NIT: Should not be page specific. ire 2018/01/30 08:19:08 I think it's very unlikely, but perhaps it could b Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > NIT: Should not be page specific. I think it's very unlikely, but perhaps it could be different for different pages. I think the option should be there just in case.
25 - `og_title`	19 - `og_title`

26 - `og_description`	20 - `og_description`

27 - `og_image`	21 - `og_image`

28 - `og_image_alt`	22 - `og_image_alt`

29 - `og_locale`	23 - `og_locale`
juliandoucette 2018/01/30 04:04:41 NIT: Should not be set by the user/developer. NIT: Should not be set by the user/developer. ire 2018/01/30 08:19:10 Same comment as above. I can't really imagine a ca Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > NIT: Should not be set by the user/developer. Same comment as above. I can't really imagine a case where we would want to set it, but does it hurt to have the option? Particularly as there is a default that will likely be used in most cases.
30 - `facebook_id`	24 - `facebook_id`
juliandoucette 2018/01/30 04:04:41 NIT: Should not be page specific? NIT: Should not be page specific? ire 2018/01/30 08:19:09 I can imagine that there could be different pages Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > NIT: Should not be page specific? I can imagine that there could be different pages for different products within the same site that would have different facebook_id (and pinterest_id)
31 - `twitter_site`	25 - `twitter_site`

32 - `twitter_card`	26 - `twitter_card`

33 - `twitter_image`	27 - `twitter_image`

34 - `twitter_image_alt`	28 - `twitter_image_alt`

35 - `pinterest_id`	29 - `pinterest_id`
juliandoucette 2018/01/30 04:04:41 NIT: Should not be page specific? NIT: Should not be page specific? ire 2018/01/30 08:19:09 See comment above. Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > NIT: Should not be page specific? See comment above.
36	30

37 ### Global variables	31 ### Global properties

38	32

39 Additionally, the following global variables can be set for the entire site.	33 Additionally, the following properties can be set to be available for the
juliandoucette 2018/01/30 04:04:41 This is a locale string not a global variable. The This is a locale string not a global variable. The CMS has a concept of globals defined in python in the globals directory. ire 2018/01/30 08:19:10 I didn't mean it as a literal global variable. I m Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > This is a locale string not a global variable. The CMS has a concept of globals > defined in python in the globals directory. I didn't mean it as a literal global variable. I meant it more that this is a property/variable/whatever that is available globally. I've changed the wording though, let me know if it works.
	34 entire site.

40	35

41 #### Site Name	36 #### Site Name

42	37

43 In a `locales/[locale]/site.json` file:	38 In a `locales/[locale]/site.json` file:
juliandoucette 2018/01/30 04:04:41 I think that it must be defined in the defaultloca I think that it must be defined in the defaultlocale to work (not throw an error)? ire 2018/01/30 08:19:09 I don't think so. There's no file in website-defau Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > I think that it must be defined in the defaultlocale to work (not throw an > error)? I don't think so. There's no file in website-defaults and there is no error thrown.
44	39

45 ```	40 ```

46 {	41 {

47 "name": {	42 "name": {

48 "message": "eyeo",	43 "message": "eyeo",

49 "description": "Website title"	44 "description": "Website title"

50 }	45 }

51 }	46 }

52 ```	47 ```

53	48

54 #### Social accounts	49 #### Social accounts

55	50

56 In the `settings.ini` file:	51 In `/settings.ini`:
juliandoucette 2018/01/30 04:04:41 NIT: I think "In `/settings.ini`" gets the point a NIT: I think "In `/settings.ini`" gets the point across (and communicates where the file resides in the repository relative to it's base). ire 2018/01/30 08:19:09 Done. Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > NIT: I think "In `/settings.ini`" gets the point across (and communicates where > the file resides in the repository relative to it's base). Done.
57	52

58 ```	53 ```

59 [social]	54 [social]

60 facebook_id = 1234	55 facebook_id = 1234abcd
juliandoucette 2018/01/30 04:04:41 NIT: Are these IDs actually short integers? NIT: Are these IDs actually short integers? ire 2018/01/30 08:19:10 I don't think so, I think they may be alphanumeric Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > NIT: Are these IDs actually short integers? I don't think so, I think they may be alphanumeric strings
61 pinterest_id = 1234	56 pinterest_id = 1234abcd

62 twitter = @username	57 twitter = username
juliandoucette 2018/01/30 04:04:41 (Why do they make you include the @ sign!? :'( ) (Why do they make you include the @ sign!? :'( ) ire 2018/01/30 08:19:09 Done. Show quoted text On 2018/01/30 04:04:41, juliandoucette wrote: > (Why do they make you include the @ sign!? :'( ) Done.
63 ```	58 ```

LEFT	RIGHT