sitemap-brainstorming: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(New page: <entry-title>Sitemap Brainstorming</entry-title> Per the microformats process this page documents attempts to brainstorm a sitemap and related mechanisms microformat. '''Note''' : We...)
 
(→‎Content and class values: note: google ignores priority and changefreq)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<entry-title>Sitemap Brainstorming</entry-title>
{{DISPLAYTITLE:Sitemap Brainstorming}}


Per the microformats [[process]] this page documents attempts to brainstorm a sitemap and related mechanisms microformat.
Per 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''' : 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.
Line 7: Line 7:
'''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).
'''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).


== Content and class values ==
== Brainstorming solution 1 ==
* mapmf (shorthand for map microformat), required
=== Content and class values ===
** mapmf can be used to declare a link element as something the author wants considered when site mapping occurs
* h-sitemap required
** mapmf would be required to generate all the different sitemap and related mechanisms, HTML sitemap, sitemap.xml and cache manifest
** wraps a sitemap block
* priority, optional
* u-url, required
** priority is only pertinent to sitemap.xml
** every link element we want included in a generated artifact must be annotated with this
** a first iteration for defining possible values could be (p0|p1|p2|p3|p4|p5|p6|p7|p8|p9|one)
* p-priority-x, optional
** p0 = 0.0, p1 = 0.1, one = 1.0
** 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
** 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)
'''Notes''':  
* We ignore <code>lastmod</code> for now (again only pertinent to sitemap.xml)
* Google (and maybe others) ignore <code>priority</code> and <code>changefreq</code> [https://developers.google.com/search/docs/crawling-indexing/sitemaps/build-sitemap#xml]


== Examples ==
=== Examples ===
=== 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>
</nowiki></pre>
</nowiki></pre>


=== 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>
</nowiki></pre>
</nowiki></pre>


=== 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>
</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>
== see also ==
* [[sitemap]]
* [[sitemap-examples]]
* [[sitemap-formats]]
* [[sitemap-brainstorming]]
* [[sitemap-issues]]

Latest revision as of 23:21, 18 November 2024


Per 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...)

Notes:

  • We ignore lastmod for now (again only pertinent to sitemap.xml)
  • Google (and maybe others) ignore priority and changefreq [1]

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>

see also

Retrieved from "http://microformats.org/wiki/index.php?title=sitemap-brainstorming&oldid=70742"