Difference between revisions of "sitemap-brainstorming"

From Microformats Wiki
sitemap-brainstorming
Jump to navigation Jump to search
Line 9: Line 9:
 
== Brainstorming solution 1 ==
 
== Brainstorming solution 1 ==
 
=== Content and class values ===
 
=== Content and class values ===
* mapmf (shorthand for map microformat), required
+
* h-sitemap required
** mapmf can be used to declare a link element as something the author wants considered when site mapping occurs
+
** wraps a sitemap block
** mapmf would be required to generate all the different sitemap and related mechanisms, HTML sitemap, sitemap.xml and cache manifest
+
* u-url, required
* priority, optional
+
** every link element we want included in a generated artifact must be annotated with this
** priority is only pertinent to sitemap.xml
+
* p-priority-x, optional
** a first iteration for defining possible values could be (p0|p1|p2|p3|p4|p5|p6|p7|p8|p9|one)
+
** only pertinent to sitemap.xml
** p0 = 0.0, p1 = 0.1, one = 1.0
+
** p-priority-0-0 = 0.0, p-priority-0.1 = 0.1 ... p-priority-1-0 = 1.0
 
** if the author fails to specify a priority it is sane to assume a machine may generate the default of 0.5 as per the sitemaps.org protocol
 
** if the author fails to specify a priority it is sane to assume a machine may generate the default of 0.5 as per the sitemaps.org protocol
* changefreq, optional
+
* p-change-x, optional
** changefreq is only pertinent to sitemap.xml
+
** only pertinent to sitemap.xml
** we can lift the possible values directly out of the sitemaps.org protocol (always|hourly|daily|weekly|monthly|yearly|never)
+
** we can lift the possible values directly out of the sitemaps.org protocol (p-change-always|p-change-hourly...)
  
 
'''Note''' : We ignore 'lastmod' for now (again only pertinent to sitemap.xml)
 
'''Note''' : We ignore 'lastmod' for now (again only pertinent to sitemap.xml)
Line 26: Line 26:
 
==== Simple HTML sitemap or cache manifest example ====
 
==== Simple HTML sitemap or cache manifest example ====
 
<pre><nowiki>
 
<pre><nowiki>
<ul>
+
<ul class="h-sitemap">
 
   <li>
 
   <li>
     <a href="http://www.site.tld/" class="mapmf">Home</a>
+
     <a class="u-url" href="http://www.site.tld/">Home</a>
 
   </li>
 
   </li>
 
   <li>
 
   <li>
     <a href="http://www.site.tld/section1/" class="mapmf">Section 1</a>
+
     <a class="u-url" href="http://www.site.tld/section1/">Section 1</a>
 
   </li>
 
   </li>
 
</ul>
 
</ul>
Line 38: Line 38:
 
==== sitemap.xml example with changefreq specified ====
 
==== sitemap.xml example with changefreq specified ====
 
<pre><nowiki>
 
<pre><nowiki>
<ul>
+
<ul class="h-sitemap">
 
   <li>
 
   <li>
     <a href="http://www.site.tld/" class="mapmf daily">Home</a>
+
     <a class="u-url p-change-daily" href="http://www.site.tld/">Home</a>
 
   </li>
 
   </li>
 
   <li>
 
   <li>
     <a href="http://www.site.tld/section1/" class="mapmf weekly">Section 1</a>
+
     <a class="u-url p-change-weekly" href="http://www.site.tld/section1/">Section 1</a>
 
   </li>
 
   </li>
 
</ul>
 
</ul>
Line 50: Line 50:
 
==== sitemap.xml example with changefreq and priority specified ====
 
==== sitemap.xml example with changefreq and priority specified ====
 
<pre><nowiki>
 
<pre><nowiki>
<ul>
+
<ul class="h-sitemap">
 
   <li>
 
   <li>
     <a href="http://www.site.tld/" class="mapmf daily one">Home</a>
+
     <a class="u-url p-change-daily p-priority-1-0" href="http://www.site.tld/">Home</a>
 
   </li>
 
   </li>
 
   <li>
 
   <li>
     <a href="http://www.site.tld/section1/" class="mapmf weekly p8">Section 1</a>
+
     <a class="u-url p-change-weekly p-priority-0-8" href="http://www.site.tld/section1/">Section 1</a>
 
   </li>
 
   </li>
 
</ul>
 
</ul>
 +
</nowiki></pre>
 +
 +
==== sitemap.xml example where nav mechanism is structured differently ====
 +
<pre><nowiki>
 +
<div class="h-sitemap">
 +
  <a class="u-url p-change-weekly p-priority-0-6" href="/section1">Section 1</a>
 +
  <span>.</span>
 +
  <a class="u-url p-change-monthly p-priority-0-4" href="/section2">Section 2</a>
 +
</div>
 
</nowiki></pre>
 
</nowiki></pre>

Revision as of 20:50, 23 April 2012

<entry-title>Sitemap Brainstorming</entry-title>

Per the microformats The microformats process this page documents attempts to brainstorm a sitemap and related mechanisms microformat.

Note : We define 'site mapping' as the process of generating a particular sitemap flavour, like sitemap.xml or an HTML sitemap, or something related like an HTML5 cache manifest.

Note : Here we are attempting to derive a simple mechanism, lowest common denominator and driven by a top level HTML nav mechanism. We are not considering crawlers etc just yet. It is possible that later when/if we look at crawlers we may need to encode some kind of order information (for now this is explicitly defined in the order the author defined the link elements).

Brainstorming solution 1

Content and class values

  • h-sitemap required
    • wraps a sitemap block
  • u-url, required
    • every link element we want included in a generated artifact must be annotated with this
  • p-priority-x, optional
    • only pertinent to sitemap.xml
    • p-priority-0-0 = 0.0, p-priority-0.1 = 0.1 ... p-priority-1-0 = 1.0
    • if the author fails to specify a priority it is sane to assume a machine may generate the default of 0.5 as per the sitemaps.org protocol
  • p-change-x, optional
    • only pertinent to sitemap.xml
    • we can lift the possible values directly out of the sitemaps.org protocol (p-change-always|p-change-hourly...)

Note : We ignore 'lastmod' for now (again only pertinent to sitemap.xml)

Examples

Simple HTML sitemap or cache manifest example

<ul class="h-sitemap">
  <li>
    <a class="u-url" href="http://www.site.tld/">Home</a>
  </li>
  <li>
    <a class="u-url" href="http://www.site.tld/section1/">Section 1</a>
  </li>
</ul>

sitemap.xml example with changefreq specified

<ul class="h-sitemap">
  <li>
    <a class="u-url p-change-daily" href="http://www.site.tld/">Home</a>
  </li>
  <li>
    <a class="u-url p-change-weekly" href="http://www.site.tld/section1/">Section 1</a>
  </li>
</ul>

sitemap.xml example with changefreq and priority specified

<ul class="h-sitemap">
  <li>
    <a class="u-url p-change-daily p-priority-1-0" href="http://www.site.tld/">Home</a>
  </li>
  <li>
    <a class="u-url p-change-weekly p-priority-0-8" href="http://www.site.tld/section1/">Section 1</a>
  </li>
</ul>

sitemap.xml example where nav mechanism is structured differently

<div class="h-sitemap">
  <a class="u-url p-change-weekly p-priority-0-6" href="/section1">Section 1</a>
  <span>.</span>
  <a class="u-url p-change-monthly p-priority-0-4" href="/section2">Section 2</a>
</div>