Author: radu
Date: Sat Oct 11 20:24:00 2014
New Revision: 1631111
URL: http://svn.apache.org/r1631111
Log:
added news from old site, improved news layout, added browsermap module
documentation, updated home page
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_data/members/bdelacretaz.yml
incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/page.html
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-03-19-logcapture-prototype.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-06-31-dynamic-client-side-probes.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-13-online-device-detection-test-service.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-15-new-committers.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2014-08-01-first-release.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/
incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/.htaccess
- copied, changed from r1620299,
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/.htaccess
incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.cgi
- copied, changed from r1620299,
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.cgi
incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.md
- copied, changed from r1620299,
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/modules/
incubator/devicemap/whiteboard/devicemap-site-jekyll/modules/browsermap/
incubator/devicemap/whiteboard/devicemap-site-jekyll/modules/browsermap/index.md
Removed:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2014-07-10-yes-yes.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2014-08-10-hello-world.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/.htaccess
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.cgi
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.md
Modified:
incubator/devicemap/whiteboard/devicemap-site-jekyll/README.md
incubator/devicemap/whiteboard/devicemap-site-jekyll/_config.yml
incubator/devicemap/whiteboard/devicemap-site-jekyll/_includes/navigation.html
incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/news.html
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-bootstrap-other.less
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-variables.less
incubator/devicemap/whiteboard/devicemap-site-jekyll/css/devicemap.css
incubator/devicemap/whiteboard/devicemap-site-jekyll/index.md
Modified: incubator/devicemap/whiteboard/devicemap-site-jekyll/README.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/README.md?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
--- incubator/devicemap/whiteboard/devicemap-site-jekyll/README.md (original)
+++ incubator/devicemap/whiteboard/devicemap-site-jekyll/README.md Sat Oct 11
20:24:00 2014
@@ -24,7 +24,7 @@ This project provides a Jekyll setup, to
vagrant@devicemap-site-builder:/vagrant$ jekyll serve --watch
--force_polling
```
-8. Access the website at
(http://devicemap-site-builder:4000/)[http://devicemap-site-builder:4000/]
+8. Access the website at
(http://devicemap-site-builder:4000/devicemap/)[http://devicemap-site-builder:4000/devicemap/]
9. In case you want to change the styling, check the `_less` folder.
Recompiling the changes can be done inside the `devicemap-site-builder` VM by
running:
```bash
vagrant@devicemap-site-builder:/vagrant$ lessc
_less/devicemap-bootstrap.less > css/devicemap.css
Modified: incubator/devicemap/whiteboard/devicemap-site-jekyll/_config.yml
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_config.yml?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
--- incubator/devicemap/whiteboard/devicemap-site-jekyll/_config.yml (original)
+++ incubator/devicemap/whiteboard/devicemap-site-jekyll/_config.yml Sat Oct 11
20:24:00 2014
@@ -11,3 +11,6 @@ destination: public
encoding: utf-8
exclude: ["_less/", "_vagrant/"]
excerpt_separator: "<!--more-->"
+baseurl: /devicemap
+homepage:
+ news_items: 3
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_data/members/bdelacretaz.yml
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_data/members/bdelacretaz.yml?rev=1631111&view=auto
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_data/members/bdelacretaz.yml
(added)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_data/members/bdelacretaz.yml
Sat Oct 11 20:24:00 2014
@@ -0,0 +1,2 @@
+name: Bertrand Delacretaz
+url: https://twitter.com/bdelacretaz
Modified:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_includes/navigation.html
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_includes/navigation.html?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_includes/navigation.html
(original)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_includes/navigation.html
Sat Oct 11 20:24:00 2014
@@ -23,7 +23,7 @@
<li><a
href="{{site.baseurl}}/modules/devicemap-dot-net/">DeviceMap .Net
Clients</a></li>
</ul>
</li>
- <li><a href="{{site.baseurl}}/download/">Download</a></li>
+ <li><a href="{{site.baseurl}}/downloads/">Downloads</a></li>
</ul>
</div>
</div>
Modified:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/news.html
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/news.html?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
--- incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/news.html
(original)
+++ incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/news.html Sat
Oct 11 20:24:00 2014
@@ -10,7 +10,8 @@ layout: default
<span class="news-item-author">
{% assign author = site.data.members[page.author] %}
{% if author.url %}<a href="{{author.url}}">{% endif %}
- {{author.name}}
+ {{ author.name }}
+ {% unless author %}{{ page.author }}{% endunless %}
{% if author.url %}
</a>
{% endif %}
Added: incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/page.html
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/page.html?rev=1631111&view=auto
==============================================================================
--- incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/page.html
(added)
+++ incubator/devicemap/whiteboard/devicemap-site-jekyll/_layouts/page.html Sat
Oct 11 20:24:00 2014
@@ -0,0 +1,9 @@
+---
+layout: default
+---
+<div class="page">
+ {% if page.title %}
+ <h2>{{ page.title }}</h2>
+ {% endif %}
+ {{ content }}
+</div>
Modified:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-bootstrap-other.less
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-bootstrap-other.less?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-bootstrap-other.less
(original)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-bootstrap-other.less
Sat Oct 11 20:24:00 2014
@@ -1,3 +1,7 @@
+html {
+ overflow-y: scroll;
+}
+
body {
margin: 0;
padding: 0;
Modified:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-variables.less
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-variables.less?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-variables.less
(original)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_less/devicemap-variables.less
Sat Oct 11 20:24:00 2014
@@ -1,3 +1,3 @@
-@images: '/images/site';
+@images: '/devicemap/images/site';
@news-item-date-color: #aaaaaa;
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-03-19-logcapture-prototype.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-03-19-logcapture-prototype.md?rev=1631111&view=auto
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-03-19-logcapture-prototype.md
(added)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-03-19-logcapture-prototype.md
Sat Oct 11 20:24:00 2014
@@ -0,0 +1,8 @@
+---
+layout: news
+categories: news
+author: bdelacretaz
+title: Logcapture Prototype
+---
+We have put our logcapture prototype online at
[http://devicemap-vm.apache.org/logcapture/](http://devicemap-vm.apache.org/logcapture/)
to start experimenting with analytics-like device
+information capture.
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-06-31-dynamic-client-side-probes.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-06-31-dynamic-client-side-probes.md?rev=1631111&view=auto
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-06-31-dynamic-client-side-probes.md
(added)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2012-06-31-dynamic-client-side-probes.md
Sat Oct 11 20:24:00 2014
@@ -0,0 +1,7 @@
+---
+layout: news
+categories: news
+author: bdelacretaz
+title: Dynamic Client-side Probes
+---
+New prototype using [dynamic client-side
probes](http://markmail.org/message/3bd63yqmuixn6co6) to detect device features
on the client side using javascript, results are available both on the server
and client sides.
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-13-online-device-detection-test-service.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-13-online-device-detection-test-service.md?rev=1631111&view=auto
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-13-online-device-detection-test-service.md
(added)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-13-online-device-detection-test-service.md
Sat Oct 11 20:24:00 2014
@@ -0,0 +1,12 @@
+---
+layout: news
+categories: news
+title: Online Device Detection Test Service
+author: bdelacretaz
+---
+Thanks to Reza Naghibi, our new committer, an online device detection test
service is available at
+[http://devicemap-vm.apache.org/javaservice.html](http://devicemap-vm.apache.org/javaservice.html),
+also in [JSON](http://devicemap-vm.apache.org/javaservice.js) and
+[JSON-P](http://devicemap-vm.apache.org/javaservice.js?callback=someCallback)
formats.
+
+All variants take a `ua` parameter to ask for a specific device.
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-15-new-committers.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-15-new-committers.md?rev=1631111&view=auto
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-15-new-committers.md
(added)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2013-05-15-new-committers.md
Sat Oct 11 20:24:00 2014
@@ -0,0 +1,7 @@
+---
+layout: news
+categories: news
+author: bdelacretaz
+title: New Committers
+---
+We have a new committer, Eberhard Speer Jr., after Reza Naghibi and Radu
Cotescu joined a few days ago.
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2014-08-01-first-release.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2014-08-01-first-release.md?rev=1631111&view=auto
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2014-08-01-first-release.md
(added)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/_posts/news/2014-08-01-first-release.md
Sat Oct 11 20:24:00 2014
@@ -0,0 +1,15 @@
+---
+layout: news
+categories: news
+author: rezan
+title: First Release
+---
+We're happy to announce our first release at the Apache Software Foundation.
+<!--more-->
+The following modules are now available for download:
+
+1. Device Data 1.0.0
+2. Java Client 1.0.0
+3. BrowserMap 1.4.1
+
+Head to the [Downloads](/devicemap/downloads/) page to get the artifacts.
Modified: incubator/devicemap/whiteboard/devicemap-site-jekyll/css/devicemap.css
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/css/devicemap.css?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
--- incubator/devicemap/whiteboard/devicemap-site-jekyll/css/devicemap.css
(original)
+++ incubator/devicemap/whiteboard/devicemap-site-jekyll/css/devicemap.css Sat
Oct 11 20:24:00 2014
@@ -5867,92 +5867,6 @@ button.close {
bottom: 20px;
}
}
-.clearfix:before,
-.clearfix:after,
-.dl-horizontal dd:before,
-.dl-horizontal dd:after,
-.container:before,
-.container:after,
-.container-fluid:before,
-.container-fluid:after,
-.row:before,
-.row:after,
-.form-horizontal .form-group:before,
-.form-horizontal .form-group:after,
-.btn-toolbar:before,
-.btn-toolbar:after,
-.btn-group-vertical > .btn-group:before,
-.btn-group-vertical > .btn-group:after,
-.nav:before,
-.nav:after,
-.navbar:before,
-.navbar:after,
-.navbar-header:before,
-.navbar-header:after,
-.navbar-collapse:before,
-.navbar-collapse:after,
-.pager:before,
-.pager:after,
-.panel-body:before,
-.panel-body:after,
-.modal-footer:before,
-.modal-footer:after {
- content: " ";
- display: table;
-}
-.clearfix:after,
-.dl-horizontal dd:after,
-.container:after,
-.container-fluid:after,
-.row:after,
-.form-horizontal .form-group:after,
-.btn-toolbar:after,
-.btn-group-vertical > .btn-group:after,
-.nav:after,
-.navbar:after,
-.navbar-header:after,
-.navbar-collapse:after,
-.pager:after,
-.panel-body:after,
-.modal-footer:after {
- clear: both;
-}
-.center-block {
- display: block;
- margin-left: auto;
- margin-right: auto;
-}
-.pull-right {
- float: right !important;
-}
-.pull-left {
- float: left !important;
-}
-.hide {
- display: none !important;
-}
-.show {
- display: block !important;
-}
-.invisible {
- visibility: hidden;
-}
-.text-hide {
- font: 0/0 a;
- color: transparent;
- text-shadow: none;
- background-color: transparent;
- border: 0;
-}
-.hidden {
- display: none !important;
- visibility: hidden !important;
-}
-.affix {
- position: fixed;
- -webkit-transform: translate3d(0, 0, 0);
- transform: translate3d(0, 0, 0);
-}
@-ms-viewport {
width: device-width;
}
@@ -6163,12 +6077,15 @@ button.close {
display: none !important;
}
}
+html {
+ overflow-y: scroll;
+}
body {
margin: 0;
padding: 0;
}
.navbar-brand {
- background: url('/images/site/devicemap_alt_2.svg') no-repeat 50% 50%;
+ background: url('/devicemap/images/site/devicemap_alt_2.svg') no-repeat 50%
50%;
height: 90px;
width: 200px;
padding: 0;
@@ -6205,3 +6122,89 @@ ul.news-items .news-item-meta {
.news-item-excerpt {
margin-bottom: 36px;
}
+.clearfix:before,
+.clearfix:after,
+.dl-horizontal dd:before,
+.dl-horizontal dd:after,
+.container:before,
+.container:after,
+.container-fluid:before,
+.container-fluid:after,
+.row:before,
+.row:after,
+.form-horizontal .form-group:before,
+.form-horizontal .form-group:after,
+.btn-toolbar:before,
+.btn-toolbar:after,
+.btn-group-vertical > .btn-group:before,
+.btn-group-vertical > .btn-group:after,
+.nav:before,
+.nav:after,
+.navbar:before,
+.navbar:after,
+.navbar-header:before,
+.navbar-header:after,
+.navbar-collapse:before,
+.navbar-collapse:after,
+.pager:before,
+.pager:after,
+.panel-body:before,
+.panel-body:after,
+.modal-footer:before,
+.modal-footer:after {
+ content: " ";
+ display: table;
+}
+.clearfix:after,
+.dl-horizontal dd:after,
+.container:after,
+.container-fluid:after,
+.row:after,
+.form-horizontal .form-group:after,
+.btn-toolbar:after,
+.btn-group-vertical > .btn-group:after,
+.nav:after,
+.navbar:after,
+.navbar-header:after,
+.navbar-collapse:after,
+.pager:after,
+.panel-body:after,
+.modal-footer:after {
+ clear: both;
+}
+.center-block {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+.pull-right {
+ float: right !important;
+}
+.pull-left {
+ float: left !important;
+}
+.hide {
+ display: none !important;
+}
+.show {
+ display: block !important;
+}
+.invisible {
+ visibility: hidden;
+}
+.text-hide {
+ font: 0/0 a;
+ color: transparent;
+ text-shadow: none;
+ background-color: transparent;
+ border: 0;
+}
+.hidden {
+ display: none !important;
+ visibility: hidden !important;
+}
+.affix {
+ position: fixed;
+ -webkit-transform: translate3d(0, 0, 0);
+ transform: translate3d(0, 0, 0);
+}
Copied:
incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/.htaccess (from
r1620299,
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/.htaccess)
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/.htaccess?p2=incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/.htaccess&p1=incubator/devicemap/whiteboard/devicemap-site-jekyll/download/.htaccess&r1=1620299&r2=1631111&rev=1631111&view=diff
==============================================================================
(empty)
Copied:
incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.cgi (from
r1620299,
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.cgi)
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.cgi?p2=incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.cgi&p1=incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.cgi&r1=1620299&r2=1631111&rev=1631111&view=diff
==============================================================================
(empty)
Copied: incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.md
(from r1620299,
incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.md)
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.md?p2=incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.md&p1=incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.md&r1=1620299&r2=1631111&rev=1631111&view=diff
==============================================================================
--- incubator/devicemap/whiteboard/devicemap-site-jekyll/download/index.md
(original)
+++ incubator/devicemap/whiteboard/devicemap-site-jekyll/downloads/index.md Sat
Oct 11 20:24:00 2014
@@ -43,7 +43,7 @@ Other mirrors: <select name="Preferred">
You may also consult the [complete list of
mirrors](http://www.apache.org/mirrors/)
-## Verifying the downloaded archives
+### Verifying the downloaded archives
Make sure to verify the integrity of any downloads using the provided
signatures and/or digests.
The signatures and digests must be downloaded from apache.org, links are
provided below.
Modified: incubator/devicemap/whiteboard/devicemap-site-jekyll/index.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/index.md?rev=1631111&r1=1631110&r2=1631111&view=diff
==============================================================================
--- incubator/devicemap/whiteboard/devicemap-site-jekyll/index.md (original)
+++ incubator/devicemap/whiteboard/devicemap-site-jekyll/index.md Sat Oct 11
20:24:00 2014
@@ -3,22 +3,19 @@ layout: default
---
## What Is Apache DeviceMap? {#about}
-Apache DeviceMap is an [incubating](http://incubator.apache.org "Apache
Incubator") project to create a data repository containing device information,
images and other relevant
-information for all sorts of mobile devices, e.g. smartphones and tablets.
+Apache DeviceMap is an [incubating](http://incubator.apache.org "Apache
Incubator") project providing device detection modules for web applications.
-While the focus is initially on that data, APIs will also be created to use
and manage it.
+The project currently provides two server-side detection modules, one for Java
and the other for .Net, and a client-side detection module.
-The project started in January 2012, at the moment (March 2012) we are
experimenting with prototypes
-that will help us gather device data. The next steps are to define a storage
structure that supports
-long-term maintenance and evolution of this data, and generating views of the
devicemap in neutral
-formats, probably JSON and/or XML.
+For more info please subscribe to our [developers' list](#contact) and join
the fun!
-For more info please subscribe to our [developers'
list](/devicemap/mailing-lists.html) and join the fun!
+{% if site.categories.news %}
## News {#news}
+{% endif %}
<ul class="news-items">
-{% for newsItem in site.categories.news %}
+{% for newsItem in site.categories.news limit:site.homepage.news_items %}
<li>
<div class="news-item-meta">
<span class="news-item-date">{{newsItem.date | date: "%b %d,
%Y"}}</span> »
@@ -28,3 +25,27 @@ For more info please subscribe to our [d
</li>
{% endfor %}
</ul>
+
+{% if site.categories.news %}
+[See all entries...](/devicemap/news/)
+{% endif %}
+
+## Contact {#contact}
+
+#### Developers Mailing List {#dev-dl}
+
+The dev mailing list is the place for discussion about developing Apache
DeviceMap or integrating its modules in your projects.
+
+- Write to
[[email protected]](mailto:[email protected])
+- Subscribe
[[email protected]](mailto:[email protected])
+- Unsubscribe
[[email protected]](mailto:[email protected])
+- Archive
[mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/incubator-devicemap-dev/)
[devicemap.markmail.org](http://devicemap.markmail.org/)
+
+#### Commits Mailing List {#commits-dl}
+
+The commits mailing list serves as a notification list for the Apache
DeviceMap code repository.
+
+- Write to
[[email protected]](mailto:[email protected])
+- Subscribe
[[email protected]](mailto:[email protected])
+- Unsubscribe
[[email protected]](mailto:[email protected])
+- Archive
[mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/incubator-devicemap-commits/)
[devicemap.markmail.org](http://devicemap.markmail.org/)
Added:
incubator/devicemap/whiteboard/devicemap-site-jekyll/modules/browsermap/index.md
URL:
http://svn.apache.org/viewvc/incubator/devicemap/whiteboard/devicemap-site-jekyll/modules/browsermap/index.md?rev=1631111&view=auto
==============================================================================
---
incubator/devicemap/whiteboard/devicemap-site-jekyll/modules/browsermap/index.md
(added)
+++
incubator/devicemap/whiteboard/devicemap-site-jekyll/modules/browsermap/index.md
Sat Oct 11 20:24:00 2014
@@ -0,0 +1,83 @@
+---
+layout: page
+title: BrowserMap
+---
+BrowserMap is a JavaScript browser features detection library. It uses modular
probes and code snippets that detect specific features of the client; these are
then used to detect the client's type and to optimize page rendering or to
provide the client with alternate website versions.
+
+In addition, BrowserMap is capable of detecting the device groups a client
belongs to. The following groups are provided by default:
+
+* `smartphone` - feature phones / smartphones;
+* `tablet` - various tablets, based on screen size and the presence of touch
capabilities (the touch events Modernizr test is used for this feature);
+* `highResolutionDisplay` - devices that report a device pixel ratio greater
or equal than 2, such as: iPhone 4 and above, iPod Touch gen. 4 and above, iPad
3, Samsung Galaxy S3, etc.;
+* `browser` - desktop browsers capable of CSS 3D transitions (another
Modernizr test is used for this feature)
+* `oldBrowser` - less modern desktop browsers
+
+### Demo
+A small demo is available at
[http://devicemap-vm.apache.org/browsermap/index.html](http://devicemap-vm.apache.org/browsermap/index.html).
+
+### Features
+
+* extensible probing mechanism;
+* on-demand probing with probes' results cache and cache clearing mechanism;
+* easy mechanism for overriding pre-defined device groups / adding new device
groups;
+* three ways of determining the correct URL to which a client should be
forwarded, depending on its device group, in order of importance:
+ * usage of `<link rel="alternate" hreflang="<language_code>"
data-bmap-devgroups="<device_group_name_list>" href="<alternate_url>" />` tags
in BrowserMap enabled pages;
+ * a specific URL defined for each `DeviceGroup` JavaScript object added to
the `BrowserMap` JavaScript object (e.g. `http://www.example.com` for
`browser`, `http://m.example.com` for `smartphone`);
+ * modify the current URL to include a `DeviceGroup` selector, in case none
of the previous two methods has been set up (e.g.
`http://www.example.com/index.smartphone.html` for the `smartphone` device
group);
+* device group override (by using a combined mechanism of a `GET` parameter
and cookie storage) so that a client from a certain device group can access the
pages designed for a different device group; for clients that do not support
cookies, the device group override uses just a `GET` parameter which can
optionally be appended to each URL pointing to a resource from the same domain
as the current resource.
+
+### BrowserMap relevant files
+The BrowserMap code is organised in two base folders:
+
+* `libs/browsermap/`:
+ * `bmap.js` - this is where the `BrowserMap` object is defined (main
object used for device detection)
+ * `bmaputil.js` - file containing helper objects and methods
+ * `devicegroups.js` - file containing the `DeviceGroups` object
descriptions for each identified device group
+ * `probes.js` - file containing various `BrowserMap` probes used to detect
various browser features that can determine a client's capabilities
+* `libs/externals/`:
+ * `modernizr/modernizr.custom.js` - a reduced
[Modernizr](http://modernizr.com/ "Modernizr") configuration
+ * `matchMedia/matchMedia.js` - the [`matchMedia.js` polyfill
project](https://github.com/paulirish/matchMedia.js/ "matchMedia.js") written
by Paul Irish
+
+### Correct order of files inclusion in an HTML page
+In order to have a functional BrowserMap instance, the previous files have to
be included in this order:
+
+ <script type="text/javascript"
src="libs/browsermap/bmaputil.js"></script>
+ <script type="text/javascript" src="libs/browsermap/bmap.js"></script>
+ <script type="text/javascript"
src="libs/externals/modernizr/modernizr.custom.js"></script>
+ <script type="text/javascript"
src="libs/externals/matchMedia/matchMedia.js"></script>
+ <script type="text/javascript"
src="libs/browsermap/probes.js"></script>
+ <script type="text/javascript"
src="libs/browsermap/devicegroups.js"></script>
+
+### `DeviceGroup`s configuration
+A `DeviceGroup` object has the following attributes:
+
+* `ranking` - determines the order in which, when added to the `BrowserMap`
object, the `DeviceGroup`s will be matched; a lower ranking means an earlier
evaluation (e.g. 0 is evaluated before 10);
+* `name` - the name of the `DeviceGroup`; can also act as a URL selector which
will be used to create `DeviceGroup`s-specific URLs to which the clients will
be forwarded
+* `description` - a string used to store a brief description of the
`DeviceGroup`
+* `testFunction` - a test function that must return a boolean value; the test
function is used to check if a client matches the `DeviceGroup` or not; the
test function can use `BrowserMap` probe functions
+* `isSelector` - a boolean flag which is checked to see if a `DeviceGroup`'s
name should be used as a selector or not.
+
+To add a `DeviceGroup` to the `BrowserMap` object, one can use the
`BrowserMap.addDeviceGroup(DeviceGroup object)` method. The last `DeviceGroup`
added to `BrowserMap` with the same name as a previously existing `DeviceGroup`
will be the one which will be stored, which can be useful if one tries to
override the default `DeviceGroups`.
+
+### Development
+BrowserMap's own source files are located in `src/main/js`.
+
+The main test file is located in `src/test/js` and the tests are based on
[QUnit](http://qunitjs.com/ "QUnit").
+
+The builds are handled with [Grunt](http://gruntjs.com/ "Grunt"). In order to
build the project you need to install
+[PhantomJS](http://phantomjs.org/ "PhantomJS"), [Node.js](http://nodejs.org/
"Node.js") and [npm](https://github.com/isaacs/npm "npm").
+Afterwards use `npm` to globally install `grunt-cli` and the development
dependencies:
+
+ npm install -g grunt-cli
+ npm install -d
+
+The tests can be run with `grunt test` inside the browsermap folder.
+
+Packaging the app is done with `grunt package`.
+
+### How to report issues or request enhancements
+Please file a JIRA issue at
[https://issues.apache.org/jira/browse/DMAP](https://issues.apache.org/jira/browse/DMAP)
and use the "browsermap"
+label.
+
+If you're reporting a bug please provide an accurate description of the
problem together with the debug output found on the demo page from
+[http://devicemap-vm.apache.org/browsermap/index.html](http://devicemap-vm.apache.org/browsermap/index.html).
