From ef877af47d94798a3ab99600b28f426edc5eb6a7 Mon Sep 17 00:00:00 2001 From: Sukru Alatas Date: Tue, 17 Jan 2017 21:18:08 +0300 Subject: [PATCH] 2.2.0 -some cleanup -web site update --- .../GeoJSON4EntityFramework.nuspec | 4 +- .../GeoJSON4EntityFramework5.nuspec | 4 +- docs/_config.yml | 8 + docs/index.md | 135 ++++++ docs/stylesheets/github-light.css | 116 +++++ docs/stylesheets/stylesheet.css | 425 ++++++++++++++++++ 6 files changed, 688 insertions(+), 4 deletions(-) create mode 100644 docs/_config.yml create mode 100644 docs/index.md create mode 100644 docs/stylesheets/github-light.css create mode 100644 docs/stylesheets/stylesheet.css diff --git a/GeoJSON4EntityFramework/GeoJSON4EntityFramework.nuspec b/GeoJSON4EntityFramework/GeoJSON4EntityFramework.nuspec index 1be1060..0a37ca8 100644 --- a/GeoJSON4EntityFramework/GeoJSON4EntityFramework.nuspec +++ b/GeoJSON4EntityFramework/GeoJSON4EntityFramework.nuspec @@ -7,7 +7,7 @@ Sukru Alatas Sukru Alatas https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/LICENSE - https://github.com/alatas/GeoJSON4EntityFramework + https://alatas.github.io/GeoJSON4EntityFramework/ https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/geojson.png true @@ -28,7 +28,7 @@ 2.2.0 -added WKT support -added geometry transform (thanks to @jumpinjackie) - -added quick start example projects to source + -added quick start and example projects -reorganized whole code base and unit tests (this means lots of deletions) -fixed some minor bugs diff --git a/GeoJSON4EntityFramework5/GeoJSON4EntityFramework5.nuspec b/GeoJSON4EntityFramework5/GeoJSON4EntityFramework5.nuspec index e55f3a9..105a9d4 100644 --- a/GeoJSON4EntityFramework5/GeoJSON4EntityFramework5.nuspec +++ b/GeoJSON4EntityFramework5/GeoJSON4EntityFramework5.nuspec @@ -7,7 +7,7 @@ Sukru Alatas Sukru Alatas https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/LICENSE - https://github.com/alatas/GeoJSON4EntityFramework + https://alatas.github.io/GeoJSON4EntityFramework/ https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/geojson.png true @@ -28,7 +28,7 @@ 2.2.0 -added WKT support -added geometry transform (thanks to @jumpinjackie) - -added quick start example projects to source + -added quick start and example projects -reorganized whole code base and unit tests (this means lots of deletions) -fixed some minor bugs diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..639a82a --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,8 @@ +title: GeoJSON4EntityFramework +description: Create GeoJSON from Entity Framework Spatial Data +google_analytics: +show_downloads: true +theme: jekyll-theme-slate + +gems: + - jekyll-mentions diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e1cc058 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,135 @@ +# GeoJSON4EntityFramework ![Logo](https://raw.githubusercontent.com/alatas/GeoJSON4EntityFramework/master/geojson.png) ![BuildStatus](https://sukru.visualstudio.com/_apis/public/build/definitions/ef35124c-d2ad-4375-9c78-8862c095207b/1/badge) +___ + +### What is GeoJSON? +[GeoJSON](http://geojson.org/) is a format for encoding a variety of geographic data structures. A GeoJSON object may represent a geometry, a feature, or a collection of features. + +In 2015, the Internet Engineering Task Force (IETF), in conjunction with the original specification authors, formed a GeoJSON WG to standardize GeoJSON. [RFC 7946](https://tools.ietf.org/html/rfc7946) was published in August 2016 and is the new standard specification of the GeoJSON format, replacing the 2008 GeoJSON specification. + +GeoJSON supports _Point_, _LineString_, _Polygon_, _MultiPoint_, _MultiLineString_, _MultiPolygon_, and _GeometryCollection_ geometry types. + +_Feature_ contain a geometry object and additional properties, and a _FeatureCollection_ represents a list of features. + +For example, A house, a road and a bus stop represents three different _Feature_. All of them might have different type of geometries. House could be a _polygon_, road could be a _linestring_ and bus stop could be a _point_. All of them represents a neighbourhood and this called _FeatureCollection_ in GeoJSON. + +### What is EntityFramework? +EntityFramework (EF) is an open source object-relational mapping [(ORM)](https://en.wikipedia.org/wiki/Object-relational_mapping) framework for Microsoft .net. It allows us to use database rows as class instances. + +### What is Well-known Text (WKT)? +[Well-known Text (WKT)](https://en.wikipedia.org/wiki/Well-known_text) is a text markup language for representing vector geometry objects on a map, spatial reference systems of spatial objects and transformations between spatial reference systems. In summary, It's a text representations of geometrical objects. + +### So, What is GeoJSON4EntityFramework ?? +_GeoJSON for EntityFramework_ is a .net library that allows you to create GeoJSON output from EntityFramework Spatial Data or WKT inputs. In other words, It serializes different type of geometry objects to GeoJSON. It's not limited to only EF entities but It can serialize WKT inputs as well. + +### Features +- [x] Supports Entity Framework v6 (System.Data.Entity.Spatial namespace) and Entity Framework v5 (System.Data.Spatial namespace) objects +- [x] Supports Well-known Text inputs +- [x] Supports DbGeometry (*planar*) and DbGeography (*geodetic "round earth"*) objects +- [x] Supports all types of features defined in geojson specs ([RFC 7946](https://tools.ietf.org/html/rfc7946)) +- [x] Supports boundingbox property defined in geojson specs ([RFC 7946](https://tools.ietf.org/html/rfc7946)) +- [x] Supports geometry transform + +--- + +### Quick Start + +#### EntityFramework Example + +**Visual Basic** + +```vbnet +Imports alatas.GeoJSON4EntityFramework + +Function GetGeoJSONFromDB() As String + Using db As New SpatialExampleEntities + Dim data = From row In db.SampleTables Select row.SpatialData + + Dim features as New FeatureCollection(data.ToArray) + Return features.Serialize(prettyPrint:=True) + End Using +End Function +``` + +**C#** + +```csharp +using alatas.GeoJSON4EntityFramework; + +public string GetGeoJSONFromDB() +{ + using (Entities db = new Entities()) + { + + DbGeometry[] data = (from row in db.SampleTables select row.SpatialData).ToArray(); + + FeatureCollection features = new FeatureCollection(data); + return features.Serialize(prettyPrint: true); + } +} +``` + +#### Well-Known Text (WKT) Example + +**Visual Basic** + +```vbnet +Imports alatas.GeoJSON4EntityFramework + +Function GetGeoJSONFromWKT() As String + Dim WKTs = {"POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))", + "MULTIPOINT ((10 40), (40 30), (20 20), (30 10))", + "LINESTRING (1 1, 2 2)"} + + Dim features as New FeatureCollection(WKTs) + Return features.Serialize(prettyPrint:=True) +End Function +``` + +**C#** + +```csharp +using alatas.GeoJSON4EntityFramework; + +public string GetGeoJSONFromWKT() +{ + string[] WKTs = { + "POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))", + "MULTIPOINT ((10 40), (40 30), (20 20), (30 10))", + "LINESTRING (1 1, 2 2)" + }; + + FeatureCollection features = new FeatureCollection(WKTs); + return features.Serialize(prettyPrint: true); +} +``` + +--- + +### Install + +#### Install with Package Manager Console - Nuget + +To install GeoJSON for Entity Framework, run the following command in the Package Manager Console + +**Entity Framework 6** + +```powershell +Install-Package GeoJSON4EntityFramework +``` + +**Entity Framework 5** + +```powershell +Install-Package GeoJSON4EntityFramework5 +``` + +#### Manual Install +Download the latest [release](https://github.com/alatas/GeoJSON4EntityFramework/releases) and add to your project references manually + +### Prerequisites +* Microsoft® System CLR Types for Microsoft® SQL Server® (x86/x64) [(SQLSysClrTypes.msi)](https://www.microsoft.com/en-us/download/details.aspx?id=49999) + +### Tests and Validation +You may validate outputs with http://geojson.io and http://geojsonlint.com +___ +Test data extracted from OpenStreetMap®. OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License](http://opendatacommons.org/licenses/odbl/) (ODbL) by the OpenStreetMap Foundation (OSMF) diff --git a/docs/stylesheets/github-light.css b/docs/stylesheets/github-light.css new file mode 100644 index 0000000..872a6f4 --- /dev/null +++ b/docs/stylesheets/github-light.css @@ -0,0 +1,116 @@ +/* + Copyright 2014 GitHub Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +*/ + +.pl-c /* comment */ { + color: #969896; +} + +.pl-c1 /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */, +.pl-s .pl-v /* string variable */ { + color: #0086b3; +} + +.pl-e /* entity */, +.pl-en /* entity.name */ { + color: #795da3; +} + +.pl-s .pl-s1 /* string source */, +.pl-smi /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ { + color: #333; +} + +.pl-ent /* entity.name.tag */ { + color: #63a35c; +} + +.pl-k /* keyword, storage, storage.type */ { + color: #a71d5d; +} + +.pl-pds /* punctuation.definition.string, string.regexp.character-class */, +.pl-s /* string */, +.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */, +.pl-sr /* string.regexp */, +.pl-sr .pl-cce /* string.regexp constant.character.escape */, +.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */, +.pl-sr .pl-sre /* string.regexp source.ruby.embedded */ { + color: #183691; +} + +.pl-v /* variable */ { + color: #ed6a43; +} + +.pl-id /* invalid.deprecated */ { + color: #b52a1d; +} + +.pl-ii /* invalid.illegal */ { + background-color: #b52a1d; + color: #f8f8f8; +} + +.pl-sr .pl-cce /* string.regexp constant.character.escape */ { + color: #63a35c; + font-weight: bold; +} + +.pl-ml /* markup.list */ { + color: #693a17; +} + +.pl-mh /* markup.heading */, +.pl-mh .pl-en /* markup.heading entity.name */, +.pl-ms /* meta.separator */ { + color: #1d3e81; + font-weight: bold; +} + +.pl-mq /* markup.quote */ { + color: #008080; +} + +.pl-mi /* markup.italic */ { + color: #333; + font-style: italic; +} + +.pl-mb /* markup.bold */ { + color: #333; + font-weight: bold; +} + +.pl-md /* markup.deleted, meta.diff.header.from-file */ { + background-color: #ffecec; + color: #bd2c00; +} + +.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ { + background-color: #eaffea; + color: #55a532; +} + +.pl-mdr /* meta.diff.range */ { + color: #795da3; + font-weight: bold; +} + +.pl-mo /* meta.output */ { + color: #1d3e81; +} + diff --git a/docs/stylesheets/stylesheet.css b/docs/stylesheets/stylesheet.css new file mode 100644 index 0000000..3da3485 --- /dev/null +++ b/docs/stylesheets/stylesheet.css @@ -0,0 +1,425 @@ +/******************************************************************************* +Slate Theme for GitHub Pages +by Jason Costello, @jsncostello +*******************************************************************************/ + +@import url(github-light.css); + +/******************************************************************************* +MeyerWeb Reset +*******************************************************************************/ + +html, body, div, span, applet, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, big, cite, code, +del, dfn, em, img, ins, kbd, q, s, samp, +small, strike, strong, sub, sup, tt, var, +b, u, i, center, +dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, +table, caption, tbody, tfoot, thead, tr, th, td, +article, aside, canvas, details, embed, +figure, figcaption, footer, header, hgroup, +menu, nav, output, ruby, section, summary, +time, mark, audio, video { + margin: 0; + padding: 0; + border: 0; + font: inherit; + vertical-align: baseline; +} + +/* HTML5 display-role reset for older browsers */ +article, aside, details, figcaption, figure, +footer, header, hgroup, menu, nav, section { + display: block; +} + +ol, ul { + list-style: none; +} + +table { + border-collapse: collapse; + border-spacing: 0; +} + +/******************************************************************************* +Theme Styles +*******************************************************************************/ + +body { + box-sizing: border-box; + color:#373737; + background: #212121; + font-size: 16px; + font-family: 'Myriad Pro', Calibri, Helvetica, Arial, sans-serif; + line-height: 1.5; + -webkit-font-smoothing: antialiased; +} + +h1, h2, h3, h4, h5, h6 { + margin: 10px 0; + font-weight: 700; + color:#222222; + font-family: 'Lucida Grande', 'Calibri', Helvetica, Arial, sans-serif; + letter-spacing: -1px; +} + +h1 { + font-size: 36px; + font-weight: 700; +} + +h2 { + padding-bottom: 10px; + font-size: 32px; + background: url('../images/bg_hr.png') repeat-x bottom; +} + +h3 { + font-size: 24px; +} + +h4 { + font-size: 21px; +} + +h5 { + font-size: 18px; +} + +h6 { + font-size: 16px; +} + +p { + margin: 10px 0 15px 0; +} + +footer p { + color: #f2f2f2; +} + +a { + text-decoration: none; + color: #007edf; + text-shadow: none; + + transition: color 0.5s ease; + transition: text-shadow 0.5s ease; + -webkit-transition: color 0.5s ease; + -webkit-transition: text-shadow 0.5s ease; + -moz-transition: color 0.5s ease; + -moz-transition: text-shadow 0.5s ease; + -o-transition: color 0.5s ease; + -o-transition: text-shadow 0.5s ease; + -ms-transition: color 0.5s ease; + -ms-transition: text-shadow 0.5s ease; +} + +a:hover, a:focus {text-decoration: underline;} + +footer a { + color: #F2F2F2; + text-decoration: underline; +} + +em { + font-style: italic; +} + +strong { + font-weight: bold; +} + +img { + position: relative; + margin: 0 auto; + max-width: 739px; + padding: 5px; + margin: 10px 0 10px 0; + border: 1px solid #ebebeb; + + box-shadow: 0 0 5px #ebebeb; + -webkit-box-shadow: 0 0 5px #ebebeb; + -moz-box-shadow: 0 0 5px #ebebeb; + -o-box-shadow: 0 0 5px #ebebeb; + -ms-box-shadow: 0 0 5px #ebebeb; +} + +p img { + display: inline; + margin: 0; + padding: 0; + vertical-align: middle; + text-align: center; + border: none; +} + +pre, code { + width: 100%; + color: #222; + background-color: #fff; + + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; + font-size: 14px; + + border-radius: 2px; + -moz-border-radius: 2px; + -webkit-border-radius: 2px; +} + +pre { + width: 100%; + padding: 10px; + box-shadow: 0 0 10px rgba(0,0,0,.1); + overflow: auto; +} + +code { + padding: 3px; + margin: 0 3px; + box-shadow: 0 0 10px rgba(0,0,0,.1); +} + +pre code { + display: block; + box-shadow: none; +} + +blockquote { + color: #666; + margin-bottom: 20px; + padding: 0 0 0 20px; + border-left: 3px solid #bbb; +} + + +ul, ol, dl { + margin-bottom: 15px +} + +ul { + list-style-position: inside; + list-style: disc; + padding-left: 20px; +} + +ol { + list-style-position: inside; + list-style: decimal; + padding-left: 20px; +} + +dl dt { + font-weight: bold; +} + +dl dd { + padding-left: 20px; + font-style: italic; +} + +dl p { + padding-left: 20px; + font-style: italic; +} + +hr { + height: 1px; + margin-bottom: 5px; + border: none; + background: url('../images/bg_hr.png') repeat-x center; +} + +table { + border: 1px solid #373737; + margin-bottom: 20px; + text-align: left; + } + +th { + font-family: 'Lucida Grande', 'Helvetica Neue', Helvetica, Arial, sans-serif; + padding: 10px; + background: #373737; + color: #fff; + } + +td { + padding: 10px; + border: 1px solid #373737; + } + +form { + background: #f2f2f2; + padding: 20px; +} + +/******************************************************************************* +Full-Width Styles +*******************************************************************************/ + +.outer { + width: 100%; +} + +.inner { + position: relative; + max-width: 640px; + padding: 20px 10px; + margin: 0 auto; +} + +#forkme_banner { + display: block; + position: absolute; + top:0; + right: 10px; + z-index: 10; + padding: 10px 50px 10px 10px; + color: #fff; + background: url('../images/blacktocat.png') #0090ff no-repeat 95% 50%; + font-weight: 700; + box-shadow: 0 0 10px rgba(0,0,0,.5); + border-bottom-left-radius: 2px; + border-bottom-right-radius: 2px; +} + +#header_wrap { + background: #212121; + background: -moz-linear-gradient(top, #373737, #212121); + background: -webkit-linear-gradient(top, #373737, #212121); + background: -ms-linear-gradient(top, #373737, #212121); + background: -o-linear-gradient(top, #373737, #212121); + background: linear-gradient(top, #373737, #212121); +} + +#header_wrap .inner { + padding: 50px 10px 30px 10px; +} + +#project_title { + margin: 0; + color: #fff; + font-size: 42px; + font-weight: 700; + text-shadow: #111 0px 0px 10px; +} + +#project_tagline { + color: #fff; + font-size: 24px; + font-weight: 300; + background: none; + text-shadow: #111 0px 0px 10px; +} + +#downloads { + position: absolute; + width: 210px; + z-index: 10; + bottom: -40px; + right: 0; + height: 70px; + background: url('../images/icon_download.png') no-repeat 0% 90%; +} + +.zip_download_link { + display: block; + float: right; + width: 90px; + height:70px; + text-indent: -5000px; + overflow: hidden; + background: url(../images/sprite_download.png) no-repeat bottom left; +} + +.tar_download_link { + display: block; + float: right; + width: 90px; + height:70px; + text-indent: -5000px; + overflow: hidden; + background: url(../images/sprite_download.png) no-repeat bottom right; + margin-left: 10px; +} + +.zip_download_link:hover { + background: url(../images/sprite_download.png) no-repeat top left; +} + +.tar_download_link:hover { + background: url(../images/sprite_download.png) no-repeat top right; +} + +#main_content_wrap { + background: #f2f2f2; + border-top: 1px solid #111; + border-bottom: 1px solid #111; +} + +#main_content { + padding-top: 40px; +} + +#footer_wrap { + background: #212121; +} + + + +/******************************************************************************* +Small Device Styles +*******************************************************************************/ + +@media screen and (max-width: 480px) { + body { + font-size:14px; + } + + #downloads { + display: none; + } + + .inner { + min-width: 320px; + max-width: 480px; + } + + #project_title { + font-size: 32px; + } + + h1 { + font-size: 28px; + } + + h2 { + font-size: 24px; + } + + h3 { + font-size: 21px; + } + + h4 { + font-size: 18px; + } + + h5 { + font-size: 14px; + } + + h6 { + font-size: 12px; + } + + code, pre { + min-width: 320px; + max-width: 480px; + font-size: 11px; + } + +}