Platform Team/Guide/Sweets Usage: Difference between revisions

Line 68:

If sweets can't find proper implementation, see the {{Code|E}} lines in output of:

sweets show sdk/sugar -vdd

== Search ==

It is possible to search sweets among locally known ones and registered on http://obs.sugarlabs.org (not yet implemented). The search is based on [http://xapian.org/ Xapian] search engine. Thus, it is possible to use Xapian's [http://xapian.org/docs/queryparser.html query language].

Notice that [http://xapian.org/docs/queryparser.html#partially-entered-query-matching partial] search is enabled. So, the query {{Code|tele}} will be treated as {{Code|tele*}} to search all words that start from {{Code|tele}}.

Sweets supports following search [http://xapian.org/docs/queryparser.html#searching-within-a-probabilistic-field prefixes] basing of [[Platform_Team/Recipe_Specification|recipe options]]:

* '''interface''' interface url, e.g., {{Code|http://sweets.sugarlabs.org/sdk/sugar}};

* '''sweet''' interface in short Sweets notations, e.g., {{Code|sdk/sugar}};

* '''implement''' the list of implemented interfaces;

* '''associate''' the list of associated interface;

* '''name''' the short name of a sweet;

* '''summary''' sweet's summary;

* '''description''' long sweet's description;

* '''category''' list of category names;

* '''license''' list of licenses;

* '''type''' sweet's type, might be {{Code|library}}, {{Code|application}} or {{Code|activity}};

* '''keep''' if activity, that a sweet is representing, is favorited;

* '''tags''' the list of sweet's tags;

* '''mime_types''' the list of MIME types activity, that a sweet is representing, supports.

So, it possible to search only among particular sweet attributes, like {{Code|name:telepathy}} to search only among sweet names.

Sweets support additional notation for exact searching in form of {{Code|''prefix''<nowiki>:=</nowiki>''string''}}. For example the query {{Code|name<nowiki>:=</nowiki>sugar}} will find sweets only with exactly {{Code|sugar}} name and omit names like {{Code|sugar-base}}. If search string contains spaces, wrap it to double quotes, {{Code|name<nowiki>:=</nowiki>"Sugar Commander"}}. Note, wildcards does not work in exact search case and asterisks will be treated literally.

== Development workflow with sweets ==

@@ Line 68: / Line 68: @@
 If sweets can't find proper implementation, see the {{Code|E}} lines in output of:
   sweets show sdk/sugar -vdd
+== Search ==
+It is possible to search sweets among locally known ones and registered on http://obs.sugarlabs.org (not yet implemented). The search is based on [http://xapian.org/ Xapian] search engine. Thus, it is possible to use Xapian's [http://xapian.org/docs/queryparser.html query language].
+Notice that [http://xapian.org/docs/queryparser.html#partially-entered-query-matching partial] search is enabled. So, the query {{Code|tele}} will be treated as {{Code|tele*}} to search all words that start from {{Code|tele}}.
+Sweets supports following search [http://xapian.org/docs/queryparser.html#searching-within-a-probabilistic-field prefixes] basing of [[Platform_Team/Recipe_Specification|recipe options]]:
+* '''interface''' interface url, e.g., {{Code|http://sweets.sugarlabs.org/sdk/sugar}};
+* '''sweet''' interface in short Sweets notations, e.g., {{Code|sdk/sugar}};
+* '''implement''' the list of implemented interfaces;
+* '''associate''' the list of associated interface;
+* '''name''' the short name of a sweet;
+* '''summary''' sweet's summary;
+* '''description''' long sweet's description;
+* '''category''' list of category names;
+* '''license''' list of licenses;
+* '''type''' sweet's type, might be {{Code|library}}, {{Code|application}} or {{Code|activity}};
+* '''keep''' if activity, that a sweet is representing, is favorited;
+* '''tags''' the list of sweet's tags;
+* '''mime_types''' the list of MIME types activity, that a sweet is representing, supports.
+So, it possible to search only among particular sweet attributes, like {{Code|name:telepathy}} to search only among sweet names.
+Sweets support additional notation for exact searching in form of {{Code|''prefix''<nowiki>:=</nowiki>''string''}}. For example the query {{Code|name<nowiki>:=</nowiki>sugar}} will find sweets only with exactly {{Code|sugar}} name and omit names like {{Code|sugar-base}}. If search string contains spaces, wrap it to double quotes, {{Code|name<nowiki>:=</nowiki>"Sugar Commander"}}. Note, wildcards does not work in exact search case and asterisks will be treated literally.
 == Development workflow with sweets ==