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

From MozillaWiki
Jump to navigation Jump to search
Line 27: Line 27:
The contents for a folder are given as an array of objects, representing various bookmark types, described below.
The contents for a folder are given as an array of objects, representing various bookmark types, described below.


==== Bookmark ====
==== Bookmark Object ====


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.
* '''after''': the title of the bookmark item expected to be found AFTER this bookmark; used only in '''verify''' and '''modify''' actions.
* '''before''': the title of the bookmark item expected to be found BEFORE this
bookmark; used only in '''verify''' and '''modify''' actions.
* '''changes''': an object containing new properties to be set for this bookmark when this asset list is used in a '''modify''' action.  The properties for this object include the '''uri, title, loadInSidebar, description, tags, keyword''' properties above, plus two additional properties:
** '''location''':  the full path of the folder that the bookmark should be moved to
** '''position''':  the title of the existing bookmark item, in the current folder, where this bookmark should be moved to (i.e., this bookmark would be inserted into the bookmark list at the position of the named bookmark, causing that bookmark to be positioned below the current one)


Example:
Example:
Line 43: Line 49:
     "title": "Google" }
     "title": "Google" }


==== Livemark ====
==== Livemark Object ====


Valid properties are:
Valid properties are:
Line 54: Line 60:
  { "livemark": "Livemark1", "feedUri": "http://rss.wunderground.com/blog/JeffMasters/rss.xml",
  { "livemark": "Livemark1", "feedUri": "http://rss.wunderground.com/blog/JeffMasters/rss.xml",
   "siteUri": "http://www.wunderground.com/blog/JeffMasters/show.html" }
   "siteUri": "http://www.wunderground.com/blog/JeffMasters/show.html" }
==== Folder Object ====
Valid properties are:
* folder: the folder's name.  Required.
* description: the folder's description.  Optional.

Revision as of 20:19, 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 Object

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.
  • after: the title of the bookmark item expected to be found AFTER this bookmark; used only in verify and modify actions.
  • before: the title of the bookmark item expected to be found BEFORE this

bookmark; used only in verify and modify actions.

  • changes: an object containing new properties to be set for this bookmark when this asset list is used in a modify action. The properties for this object include the uri, title, loadInSidebar, description, tags, keyword properties above, plus two additional properties:
    • location: the full path of the folder that the bookmark should be moved to
    • position: the title of the existing bookmark item, in the current folder, where this bookmark should be moved to (i.e., this bookmark would be inserted into the bookmark list at the position of the named bookmark, causing that bookmark to be positioned below the current one)

Example:

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

Livemark Object

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" }

Folder Object

Valid properties are:

  • folder: the folder's name. Required.
  • description: the folder's description. Optional.