Unified Diff: 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
Patch Set:
Created Jan. 26, 2018, 11:28 a.m.
Use n/p to move between diff chunks;
N/P to move between comments.
« pages/index.html ('K')
|
« pages/index.html ('k')
|
templates/minimal.tmpl » ('j')
|
no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| Index: pages/metadata.md |
| =================================================================== |
| new file mode 100644 |
| --- /dev/null |
| +++ b/pages/metadata.md |
| @@ -0,0 +1,63 @@ |
| +title=Metadata |
|
ire
2018/01/26 11:33:59
I added this page because 1) I think it's easier t
juliandoucette
2018/01/30 04:04:41
Acknowledged.
|
| +description=Default metadata for eyeo websites |
| + |
| +<head> |
| + <style> |
| + code { font-family: monospace; } |
|
ire
2018/01/26 11:33:59
This could/should be in website-defaults. If you a
juliandoucette
2018/01/30 04:04:41
NIT: Please add it separately and remove the head
ire
2018/01/30 08:19:10
https://codereview.adblockplus.org/29684561
|
| + </style> |
| +</head> |
| + |
| +# Metadata |
| + |
| +Default metadata for eyeo websites |
| + |
| +1. [Social metadata](#social) |
| + |
| +## Social metadata { #social } |
| + |
| +### Local variables |
| + |
| +The following variables can be set on a per page basis: |
|
juliandoucette
2018/01/30 04:04:41
NIT: Perhaps we should mention where/how they can
ire
2018/01/30 08:19:09
I think this is more global "how to use the cms" i
|
| + |
| +- `og_url` |
| +- `og_type` |
| +- `og_site_name` |
|
juliandoucette
2018/01/30 04:04:41
NIT: Should not be page specific.
ire
2018/01/30 08:19:08
I think it's very unlikely, but perhaps it could b
|
| +- `og_title` |
| +- `og_description` |
| +- `og_image` |
| +- `og_image_alt` |
| +- `og_locale` |
|
juliandoucette
2018/01/30 04:04:41
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
|
| +- `facebook_id` |
|
juliandoucette
2018/01/30 04:04:41
NIT: Should not be page specific?
ire
2018/01/30 08:19:09
I can imagine that there could be different pages
|
| +- `twitter_site` |
| +- `twitter_card` |
| +- `twitter_image` |
| +- `twitter_image_alt` |
| +- `pinterest_id` |
|
juliandoucette
2018/01/30 04:04:41
NIT: Should not be page specific?
ire
2018/01/30 08:19:09
See comment above.
|
| + |
| +### Global variables |
| + |
| +Additionally, the following global variables can be set for the entire site. |
|
juliandoucette
2018/01/30 04:04:41
This is a locale string not a global variable. The
ire
2018/01/30 08:19:10
I didn't mean it as a literal global variable. I m
|
| + |
| +#### Site Name |
| + |
| +In a `locales/[locale]/site.json` file: |
|
juliandoucette
2018/01/30 04:04:41
I think that it must be defined in the defaultloca
ire
2018/01/30 08:19:09
I don't think so. There's no file in website-defau
|
| + |
| +``` |
| +{ |
| + "name": { |
| + "message": "eyeo", |
| + "description": "Website title" |
| + } |
| +} |
| +``` |
| + |
| +#### Social accounts |
| + |
| +In the `settings.ini` file: |
|
juliandoucette
2018/01/30 04:04:41
NIT: I think "In `/settings.ini`" gets the point a
ire
2018/01/30 08:19:09
Done.
|
| + |
| +``` |
| +[social] |
| +facebook_id = 1234 |
|
juliandoucette
2018/01/30 04:04:41
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
|
| +pinterest_id = 1234 |
| +twitter = @username |
|
juliandoucette
2018/01/30 04:04:41
(Why do they make you include the @ sign!? :'( )
ire
2018/01/30 08:19:09
Done.
|
| +``` |
« pages/index.html ('K')
|
« pages/index.html ('k')
|
templates/minimal.tmpl » ('j')
|
no next file with comments »
