Docserver manifest follow up (rewrite)

chrome/common/extensions/docs/templates/json/manifest.json

Index: chrome/common/extensions/docs/templates/json/manifest.json
diff --git a/chrome/common/extensions/docs/templates/json/manifest.json b/chrome/common/extensions/docs/templates/json/manifest.json
index 4408a535e2f7acfe7890caa5a78d7ffc5416c9f1..0779006d9d11426f9ace8ca31b4ab2b48ffc4098 100644
--- a/chrome/common/extensions/docs/templates/json/manifest.json
+++ b/chrome/common/extensions/docs/templates/json/manifest.json
@@ -2,175 +2,241 @@
   "required": [
     {
       "documentation": "manifest/name.html",
-      "example": "My Extension",
+      "example": {
+        "value": "My Extension"

[not at google - send to devlin, 2013/07/02 18:23:11]

Why this extra "value" thing? Is that something I suggested? It seems
unnecessary.

[jshumway, 2013/07/24 17:40:07]

I agree, but it is necessary.

Handlebar does not distinguish between "a value does not exist" and "a value is
false" (empty string, empty list, Boolean false, etc). This was causing a bug
with the manifest example display where lots of examples were not being
displayed because the had false values! I noticed when I was messing with
background.persistent, attempting to get 'false' to be the description and it
was never showing up.

I made example a dictionary that always contains a 'value' key. Thus
{{?example}} will either be false and indicate there is no example, or true and
that there is an example. Then {{value}} can always be used as literal json to
show the example, even if the value is false.

+      },
       "name": "name"
     },
     {
       "documentation": "manifest/app.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "app"
     },
     {
       "documentation": "manifest/version.html",
-      "example": "versionString",
+      "example": {
+        "value": "versionString"
+      },
       "name": "version"
     },
     {
       "documentation": "manifest/manifest_version.html",
-      "example": 2,
+      "example": {
+        "value": 2
+      },
       "name": "manifest_version"
     }
   ],
   "recommended": [
     {
       "documentation": "manifest/description.html",
-      "example": "A plain text description",
+      "example": {
+        "value": "A plain text description"
+      },
       "name": "description"
     },
     {
       "documentation": "manifest/icons.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "icons"
     },
     {
       "documentation": "manifest/default_locale.html",
-      "example": "en",
+      "example": {
+        "value": "en"
+      },
       "name": "default_locale"
     }
   ],
   "only_one": [
     {
       "documentation": "browserAction.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "browser_action"
     },
     {
       "documentation": "pageAction.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "page_action"
     },
     {
       "documentation": "themes.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "theme"
     }
   ],
   "optional": [
     {
-      "documentation": "event_pages.html",
+      "documentation": "background_pages.html",
       "example": {
-        "persistent": false
+        "value": {
+          "persistent": true
+        }
       },
       "name": "background"
     },
     {
-      "documentation": "background_pages.html",
+      "documentation": "event_pages.html",
       "example": {
-        "persistent": true
+        "value": false
       },
       "name": "background.persistent"
     },
     {
       "documentation": "override.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "chrome_url_overrides"
     },
     {
       "documentation": "content_scripts.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "content_scripts"
     },
     {
       "documentation": "contentSecurityPolicy.html",
-      "example": "policyString",
+      "example": {
+        "value": "policyString"
+      },
       "name": "content_security_policy"
     },
     {
       "documentation": "fileBrowserHandler.html",
-      "example": [],
+      "example": {
+        "value": []
+      },
       "name": "file_browser_handlers"
     },
     {
       "documentation": "manifest/file_handlers.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "file_handlers"
     },
     {
       "documentation": "manifest/homepage_url.html",
-      "example": "http://path/to/homepage",
+      "example": {
+        "value": "http://path/to/homepage"
+      },
       "name": "homepage_url"
     },
     {
       "documentation": "manifest/incognito.html",
-      "example": "spanning or split",
+      "example": {
+        "value": "spanning or split"
+      },
       "name": "incognito"
     },
     {
       "documentation": "manifest/key.html",
-      "example": "publicKey",
+      "example": {
+        "value": "publicKey"
+      },
       "name": "key"
     },
     {
       "documentation": "manifest/minimum_chrome_version.html",
-      "example": "versionString",
+      "example": {
+        "value": "versionString"
+      },
       "name": "minimum_chrome_version"
     },
     {
       "documentation": "manifest/nacl_modules.html",
-      "example": [],
+      "example": {
+        "value": []
+      },
       "name": "nacl_modules"
     },
     {
       "documentation": "manifest/kiosk_enabled.html",
-      "example": true,
+      "example": {
+        "value": true
+      },
       "name": "kiosk_enabled"
     },
     {
       "documentation": "manifest/offline_enabled.html",
-      "example": true,
+      "example": {
+        "value": true
+      },
       "name": "offline_enabled"
     },
     {
       "documentation": "omnibox.html",
       "example": {
-        "keyword": "aString"
+        "value": {
+          "keyword": "aString"
+        }
       },
       "name": "omnibox"
     },
     {
       "documentation": "options.html",
-      "example": "aFile.html",
+      "example": {
+        "value": "aFile.html"
+      },
       "name": "options_page"
     },
     {
       "documentation": "declare_permissions.html",
-      "example": [],
+      "example": {
+        "value": []
+      },
       "name": "permissions"
     },
     {
       "documentation": "npapi.html",
-      "example": [],
+      "example": {
+        "value": []
+      },
       "name": "plugins"
     },
     {
       "documentation": "manifest/requirements.html",
-      "example": {},
+      "example": {
+        "value": {}
+      },
       "name": "requirements"
     },
     {
       "documentation": "autoupdate.html",
-      "example": "http://path/to/updateInfo.xml",
+      "example": {
+        "value": "http://path/to/updateInfo.xml"
+      },
       "name": "update_url"
     },
     {
       "documentation": "manifest/web_accessible_resources.html",
-      "example": [],
+      "example": {
+        "value": []
+      },
       "name": "web_accessible_resources"
     },
     {
       "documentation": "manifest/sandbox.html",
-      "example": [],
+      "example": {
+        "value": []
+      },
       "name": "sandbox"
+    },
+    {
+      "name": "app.background",
+      "annotation": "Optional"

[not at google - send to devlin, 2013/07/02 18:23:11]

I like it

[jshumway, 2013/07/24 17:40:07]

To make manifest.json more friendly to anyone editing it, I created a function
that automatically applies annotations to the correct documents for 'level'
(optional, required, etc) indicators. So now you don't have to guess where it
should go.

The new 'annotations' key, which expects a list, is available for adding any
additional annotations though.

     }
   ]
 }