Auto-tools/Projects/CrossWeave/Test Format/Bookmarks: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
Line 25: Line 25:
=== Folder Contents ===
=== Folder Contents ===


The contents for a folder are given as an array of objects, representing various bookmark types.
The contents for a folder are given as an array of objects, representing various bookmark types, described below.


==== Bookmark ====
==== Bookmark ====


Valid properties are:
Valid properties are:
** uri:  the bookmark uri. Required.
* uri:  the bookmark uri. Required.
** title:  the bookmark title.  Optional.  Defaults to the bookmark uri.
* title:  the bookmark title.  Optional.  Defaults to the bookmark uri.
** loadInSidebar:  true or false.  Optional.  Toggles the "load in sidebar" property.
* loadInSidebar:  true or false.  Optional.  Toggles the "load in sidebar" property.
** description:  the bookmark description.  Optional.
* description:  the bookmark description.  Optional.
** tags:  an array of tags for the bookmark.  Optional.
* tags:  an array of tags for the bookmark.  Optional.
** keyword:  the keyword for the bookmark.  Optional.
* keyword:  the keyword for the bookmark.  Optional.


Example:
Example:
Line 42: Line 42:
     "tags": ["google", "computers", "internet", "www"],
     "tags": ["google", "computers", "internet", "www"],
     "title": "Google" }
     "title": "Google" }
==== Livemark ====
Valid properties are:
* livemark: the livemark name.  Required.
* siteURI: the livemark's uri.  Optional.
* feedURI: the livemark's feed uri.  Required.
Example:
{ "livemark": "Livemark1", "feedUri": "http://rss.wunderground.com/blog/JeffMasters/rss.xml",
  "siteUri": "http://www.wunderground.com/blog/JeffMasters/show.html" }

Revision as of 20:11, 20 May 2010

A bookmark asset list is an object with one or more key-value pairs. Each key is the full path for the array of contents specified in the key's value. For example:

"bookmark-list": {
  "menu": [
    { "uri": "http://www.google.com" },
    { "folder": "folder1" }
  ],
  "menu/folder1": [
    { "uri": "http://www.mozilla.com" }
  ]
}

This describes two bookmarks, one in the "menu" folder, and the other in the "folder1" subfolder of "menu".

All bookmark paths must begin with one of the following:

  • "menu": the normal bookmarks menu
  • "toolbar": the bookmarks toolbar
  • "tags": the tags folder
  • "unfiled": the unfiled bookmarks folder
  • "places": the places root folder ("menu", "toolbar", and "unfiled" are all children of this)

Sub-folders are preceded with forward slashes, so "menu/folder1" denotes that "folder1" is a sub-folder of "menu". CrossWeave does not support forward slashes as part of a folder name.

Folder Contents

The contents for a folder are given as an array of objects, representing various bookmark types, described below.

Bookmark

Valid properties are:

  • uri: the bookmark uri. Required.
  • title: the bookmark title. Optional. Defaults to the bookmark uri.
  • loadInSidebar: true or false. Optional. Toggles the "load in sidebar" property.
  • description: the bookmark description. Optional.
  • tags: an array of tags for the bookmark. Optional.
  • keyword: the keyword for the bookmark. Optional.

Example:

 { "uri": "http://www.google.com", "loadInSidebar": true,
   "tags": ["google", "computers", "internet", "www"],
   "title": "Google" }

Livemark

Valid properties are:

  • livemark: the livemark name. Required.
  • siteURI: the livemark's uri. Optional.
  • feedURI: the livemark's feed uri. Required.

Example:

{ "livemark": "Livemark1", "feedUri": "http://rss.wunderground.com/blog/JeffMasters/rss.xml",
  "siteUri": "http://www.wunderground.com/blog/JeffMasters/show.html" }