diff --git a/docs/index.md b/docs/index.md index af1fb05..51d5217 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,4 +17,4 @@ OpenGrid is designed to be flexible with different types of data sources. Whethe ### Open Source Open source gives "OpenGrid" its name. Feel free to use it, contribute to it, or change it. Just please take a look at the project's license. - + \ No newline at end of file diff --git a/docs/layout/launch-screen.md b/docs/layout/launch-screen.md index 6ec2d73..8697046 100644 --- a/docs/layout/launch-screen.md +++ b/docs/layout/launch-screen.md @@ -22,84 +22,84 @@ n--> - - - - + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + - - + + Geo-Location Icon + - - - - - - - + + + + + + - + +
Element No.Element Name/Description
Element No.Element Name/Description
- 1. - - Quick Search box is used to perform basic searches on datasets. The question mark icon within the Quick Search box displays a cheat sheet for quick search syntax. -
- 2. - -
    -
  • Find Data Button displays the advanced search panel utilize to create more defined searches.
    • -
  • Clear Data Button, resets the map.
    • -
-
- 3. - - User Manual Link -
    -
  • Link to accessing the OpenGrid user manual.
    • -
-
- 4. - - Zoom In and Zoom Out Icon -
- 5. - - Reset Map View and Area Zoom Icon - + 1. + + Quick Search box is used to perform basic searches on datasets. The question mark icon within the Quick Search box displays a cheat sheet for quick search syntax. +
+ 2. + +
    +
  • Find Data Button displays the advanced search panel utilize to create more defined searches.
    • +
  • Clear Data Button, resets the map.
    • +
+
+ 3. + + User Manual Link +
    +
  • Link to accessing the OpenGrid user manual.
    • +
+
+ 4. + + Zoom In and Zoom Out Icon +
+ 5. + + Reset Map View and Area Zoom Icon +
- 6. - - Zoom Specification Icon + + 6. + + Zoom Specification Icon

- Full-Screen Icon + Full-Screen Icon

- Geo-Location Icon -
- 7. - - Measurement Tool -
- 8. - - Layers Icon +
+ 7. + + Measurement Tool +
+ 8. + + Layers Icon
- Consist of list of grid views and weather layers. + Consist of list of grid views and weather layers.
Base Layers Views:
        @@ -114,8 +114,8 @@ n-->
      • Sea Level Pressure
      • Temperature
-
9. @@ -181,4 +181,4 @@ map. Using navigational controls, the user will be able to: - apply measurements - - select hyperlinks + - select hyperlinks \ No newline at end of file diff --git a/docs/media/add42618.png b/docs/media/add42618.png new file mode 100644 index 0000000..3a4cd9d Binary files /dev/null and b/docs/media/add42618.png differ diff --git a/docs/media/latl.png b/docs/media/latl.png new file mode 100644 index 0000000..579a5fe Binary files /dev/null and b/docs/media/latl.png differ diff --git a/docs/media/og_fin_001.png b/docs/media/og_fin_001.png new file mode 100644 index 0000000..563a43b Binary files /dev/null and b/docs/media/og_fin_001.png differ diff --git a/docs/media/og_finonly.png b/docs/media/og_finonly.png new file mode 100644 index 0000000..1f66f49 Binary files /dev/null and b/docs/media/og_finonly.png differ diff --git a/docs/media/og_help.png b/docs/media/og_help.png new file mode 100644 index 0000000..29b5a4a Binary files /dev/null and b/docs/media/og_help.png differ diff --git a/docs/media/plcsrch.png b/docs/media/plcsrch.png new file mode 100644 index 0000000..4891d67 Binary files /dev/null and b/docs/media/plcsrch.png differ diff --git a/docs/media/strbck.png b/docs/media/strbck.png new file mode 100644 index 0000000..0974365 Binary files /dev/null and b/docs/media/strbck.png differ diff --git a/docs/quick-search/quick-search.md b/docs/quick-search/quick-search.md new file mode 100644 index 0000000..84b0d29 --- /dev/null +++ b/docs/quick-search/quick-search.md @@ -0,0 +1,86 @@ +Quick Search is a feature used to provide basic point of interest and data-set searches. It is located in the upper left corner of the application. The searches are conducted with the following syntax: keyword only <keyword only>, or keyword followed by keyphrase <keyword><keyphrase>. Quick Search supports the following commands/inputs: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Search TypeDescriptionCommand SyntaxSample
AddressDisplays information about an address as a marker on the grid; the marker is centered within the address location.<Num><Dir><St>50 W. Washington
DatasetDisplays information about a dataset as points on the grid. The points are layered based on the geographical position of the data. The maximum of 1000 points can plot on the map.<keyword only>
<keyword><keyphrase>

food_inspections
food_inspections 60604
Latitude and LongitudeDisplays lat/long coordinates as a marker on the grid.<latitude>, <longitude>41.8270, -87.6423
Place Name/TypePlots marker/s on the grid within the coordinates of the Place Name/Type.<Place Name>
<Place Type>		 + Place Name: +
    +
  • Daley Center
    • +
  • Wrigley Building
    • +
+ Place Type: +
    +
  • Pharmacy
    • +
  • Tourist Attraction
    • +
+
+ +## Performing a Quick Search +Quick Search identifies pattern matches and not exact matches within a search. + +There are rules in performing a Quick Search such guidelines are displayed in the Help Icon. To access quick help, select the question mark icon in the Quick Search bar. Quick Help is like a cheat sheet for setting up dataset searches. When the icon is selected, the panel expands with a list of several types of search syntax, that aids in performing a quick search. + +![](../media/og_help.png) + +### Dataset Search +When a search is executed the data plots as points on the grid pertaining to the type of criteria being displayed in the search bar. <keyword only> displays all unfiltered results from a dataset called food inspections. In the bottom right corner of the grid an information bar appears displaying the total number of results returned. Data points are limited to 1000 points on the grid. An example of a <keyword only> search is displayed below. + +![](../media/og_finonly.png) + +<keyword only><keyphrase> displays a parameter base search. The example below searches food inspections in zipcode 60604. + +![](../media/og_fin_001.png) + +### Address Search +The Address search returns a marker on the grid centered within the address location. + +![](../media/add42618.png) + +### Lat/Long Search +Lat/Long searches places a marker on a grid and centers within the area of the locale; within the marker it displays information about the search which is the lat and long coordinates. + +![](../media/latl.png) + +### Place Name Search +Place Name/Type searches includes but not limited to businesses, buildings, and landmarks. It plots as marker/s on a grid, centered within its location. When there are multiple pins plotted, the grid centers itself to include all search results. Each marker provides information about the search such as name, the type of search (in this case the Type is a Tourist Attraction) and its coordinates. Users can also run a quick search by Place Type such example types are: Bank, School, Church, Park, Pharmacy, etc. + +![](../media/plcsrch.png) + +Business search displays a collection of markers on the grid of a business specified. Each marker is placed within the locale of the establishment throughout the city, the maximum number of markers that can appear on grid is 20. The marker displays the name of the search, the score, the type of search and its coordinates. An example of a business search is displayed below. + +![](../media/strbck.png) diff --git a/mkdocs.yml b/mkdocs.yml index c66aa15..986e819 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,4 +42,4 @@ markdown_extensions: permalink:  - admonition: -copyright: Copyright © 2015-2016 City of Chicago and licensed under Creative Commons Attribution-ShareAlike 4.0 International. +copyright: Copyright © 2015-2016 City of Chicago and licensed under Creative Commons Attribution-ShareAlike 4.0 International. \ No newline at end of file diff --git a/site/index.html b/site/index.html index 8a605a6..274ff77 100644 --- a/site/index.html +++ b/site/index.html @@ -44,11 +44,11 @@ @@ -256,7 +256,7 @@

Open SourceMkDocs using a theme provided by Read the Docs. - + @@ -283,4 +283,4 @@

Open Source +--> \ No newline at end of file diff --git a/site/layout/launch-screen/index.html b/site/layout/launch-screen/index.html index 8f3580c..1800e6f 100644 --- a/site/layout/launch-screen/index.html +++ b/site/layout/launch-screen/index.html @@ -44,16 +44,16 @@ @@ -430,7 +430,7 @@

Map NavigationMkDocs using a theme provided by Read the Docs. - + @@ -454,4 +454,4 @@

Map Navigation - + \ No newline at end of file diff --git a/site/map-layers/index.html b/site/map-layers/index.html index e1ab13d..eb0ed30 100644 --- a/site/map-layers/index.html +++ b/site/map-layers/index.html @@ -44,16 +44,16 @@ @@ -291,7 +291,7 @@

Open Weather MapsMkDocs using a theme provided by Read the Docs. - + @@ -315,4 +315,4 @@

Open Weather Maps - + \ No newline at end of file