Webmaker/searching: Difference between revisions

Jump to navigation Jump to search
 
Line 1: Line 1:
= How to Search =
= Searching webmaker.org =


Every make that Webmaker.org knows about can be searched for thanks to metadata stored in the [https://github.com/mozilla/MakeAPI Make API] about each and every make. The Make API is a tool that indexes all the makes created by Webmakers around the world, and exposes their data for searching.
Webmaker.org's [https://webmaker.org/en-US/search search feature] allows you to search for content by Title, Description, Tags and Users. This is possible thanks to metadata stored in the [https://github.com/mozilla/MakeAPI Make API] about each Make on the site.


[https://webmaker.org/search Webmaker.org's search page] uses the [https://github.com/mozilla/makeapi-client MakeAPI's search API] to find makes based on your interests.
Searching is different from filtering because it allows you to find Makes based on any keyword you want. Filtering only shows the content that has been selected by the Webmaker Team.


We're constantly building upon and improving our tools, And this page will attempt to keep you informed of the latest search capabilities available. If something appears to be broken, or out of date, please [https://bugzilla.mozilla.org/enter_bug.cgi?product=Webmaker&component=General file a bug on Bugzilla].
We're constantly improving our tools and this page will keep you informed of the latest search capabilities available. If something appears to be broken or out of date, please [https://bugzilla.mozilla.org/ file a bug on Bugzilla.]  


=== Search Type ===
By default, your search query will filter for matches on a make's title, description, tags and Webmaker username.


You can select which attribute of a make you would like to have your search query applied to by selecting it with the drop down menu to the left of the search input box.
=== How to Search ===
Click on the magnifying glass near the top right corner of any Webmaker page.
 
Webmaker automatically searches all categories (Title, Description, Tag and Users). If you would like to search using a specific category, click the drop down menu to the left of where you enter your search:


[[File:webmaker-choose-type.png|How To Choose Your Search Type|500px]]
[[File:webmaker-choose-type.png|How To Choose Your Search Type|500px]]


=== User ===
Searching by user allows you to find makes created by a specific person or entity.


[[File:webmaker-user-search.png|Example of User Search|500px]]
=== Searching by Title ===


=== Title, Description ===
Searching by Title will bring up Makes with that exact title.
When searching for title and description, the contents of the search input are used as-is. This means that if you enter "My Gig Poster" (without quotes) and select a title or description filtered search, your results will only contain makes that match the query exactly as it is.
 
'''Do not include quotes unless they are part of the title.'''
 
Try entering ''My Gig Poster'' to find that specific Make:


[[File:webmaker-title-search.png|Example of a Title search|500px]]
[[File:webmaker-title-search.png|Example of a Title search|500px]]


We're working to enhance the search tools to allow for full-text searching on title and description, updates will be posted here as soon as they're available to use!
(Fun experiment: Try some random words like ''pizza'' to see what you get!)


=== Tags ===
=== Searching by Description  ===
Tags are snippets of text that describe a make. A make can have zero or many tags. Tags can contain any letters or numbers. Tags can also contain symbols, with some exceptions.  
Searching by Description allows you to find words that have been entered into the description field of a Make.  


Commas have special meaning in our search tools, and can not be used in tags (see explanation about tag search syntax below).
Try entering ''dog'' to find Makes that include the word dog in their description field:


A colon (':') in a tag indicates what we call an Application Tag. These tags cannot be applied by webmaker users, but are searchable. An example of a commonly used Application Tag is: "webmaker:featured" (without quotes)
[[File:Webmaker-description-dog.png|Example of a Title search|500px]]
 
=== Searching by Tags  ===
Tags are snippets of text that describe a Make. Tags can contain any letters or numbers and most symbols, with a few important exceptions:
 
-  Commas have special meaning in our search tools. We use them to separate multiple tags, so they cannot be used ''as'' tags.
 
A colon (':') in a tag indicates what we call an Application Tag. These tags cannot be applied by Webmaker users, but are searchable. An example of a commonly used Application Tag is webmaker:featured.  This search will return a list of Makes that the Webmaker Team has labelled as Featured:


[[File:webmaker-app-tag.png|Searching for an Application Tag|500px]]
[[File:webmaker-app-tag.png|Searching for an Application Tag|500px]]


To search for a single tag, simply type it into the search input area:
To search for a single tag, simply type it into the search input area:  


[[File:Webmaker-searchingForOneTag.png|How to search for a single tag|500px]]
[[File:Webmaker-searchingForOneTag.png|How to search for a single tag|500px]]


To search for multiple tags, enter them into the search box and separate them with commas:
To search for multiple tags, enter them into the search box and separate them with commas:  


[[File:Webmaker-multiTagSearch.png|How to search for multiple tags|500px]]
[[File:Webmaker-multiTagSearch.png|How to search for multiple tags|500px]]
=== Searching by Users ===
Searching by Users allows you to find makes created by a specific person or entity. Try entering ''bboyinteractive'' to get a list of all the Makes uploaded by that user:
[[File:Bboyinteractive.png|Searching for an Application Tag|500px]]
=== Upcoming Improvements ===
We're working to enhance the search tools to allow for full-text searching on title and description. Updates will be posted here as soon as they're available to use.
Confirmed users
20

edits

Navigation menu