Documentation tweaks
authorDan Vanderkam <danvdk@gmail.com>
Sat, 29 Nov 2014 16:42:26 +0000 (11:42 -0500)
committerDan Vanderkam <danvdk@gmail.com>
Sat, 29 Nov 2014 16:42:26 +0000 (11:42 -0500)
docs/ie.html
docs/per-axis.html
docs/site.css
docs/tutorial.html
generate-documentation.py

index 9b0579f..70ad4ac 100644 (file)
@@ -10,6 +10,8 @@
 
 <p>When IE9 is in HTML5 mode, dygraphs works just like in other modern browsers.</p>
 
+<p>You should seriously consider stopping here! Older versions of IE have a small market share that's decreasing by the day. <a href="http://www.nytimes.com/">Major web sites</a> have dropped support for IE8. Future versions of dygraphs will do the same. But if you insist&hellip;</p>
+
 <p>If you want to support previous versions of Internet Explorer (IE6&ndash;IE8), you'll need to include the <a href="http://code.google.com/p/explorercanvas/">excanvas</a> library, which emulates the <code>&lt;canvas&gt;</code> tag using VML. You can add excanvas by including the following snippet:</p>
 
 <pre>
index df59a3d..09c6ebc 100644 (file)
@@ -39,11 +39,13 @@ write:</p>
                   ...,
                   {
                     strokeWidth: 5,  // default stroke width
-                    'Y1': {
-                      strokeWidth: 3  // Y1 gets a special value.
-                    },
-                    'Y3': {
-                      strokeWidth: 1  // so does Y3.
+                    series: {
+                      Y1: {
+                        strokeWidth: 3  // Y1 gets a special value.
+                      },
+                      Y3: {
+                        strokeWidth: 1  // so does Y3.
+                      }
                     }
                   });
 </pre>
index 3c81eba..58232d7 100644 (file)
@@ -131,17 +131,24 @@ pre{
 
 /* When you visit dygraphs.com/options.html#errorBars, the fixed top nav
  * obscures the top 100px of content for that anchor. This is a workaround.
- * See http://stackoverflow.com/questions/9047703/fixed-position-navbar-obscures-anchors
+ * See http://stackoverflow.com/questions/10732690/offsetting-an-html-anchor-to-adjust-for-fixed-header
  */
 a[name] {
-  padding-top: 100px;  /* matches body { padding-top } */
-  margin-top: -100px;  /* matches body { padding-top } */
-  display: inline-block; /* required for webkit browsers */
+  display: block;
+  position: relative;
+  top: -100px;
+  visibility: hidden;
 }
 @media screen and (min-width: 768px) and (max-width: 992px) {
   a[name] {
-    padding-top: 130px;  /* matches body { padding-top } */
-    margin-top: -130px;  /* matches body { padding-top } */
-    display: inline-block; /* required for webkit browsers */
+    top: -130px;
   }
 }
+a.link {
+  visibility: hidden;
+  text-decoration: none;
+  color: #777;
+}
+.option:hover a.link {
+  visibility: visible;
+}
index c4e4dc5..a8f84f0 100644 (file)
@@ -6,7 +6,7 @@
   }
 </style>
 
-<p>To use dygraphs, include the <code><a href="download.html">dygraph-combined.js</a></code> JavaScript file and instantiate a <code>Dygraph</code> object.</p>
+<p>To use dygraphs, include the <code><a href="download.html">dygraph-combined-dev.js</a></code> JavaScript file and instantiate a <code>Dygraph</code> object.</p>
 
 <p>Here's a basic example to get things started:</p>
 
@@ -17,7 +17,7 @@
 &lt;html&gt;
 &lt;head&gt;
 &lt;script type=&quot;text/javascript&quot;
-  src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
+  src=&quot;dygraph-combined-dev.js&quot;&gt;&lt;/script&gt;
 &lt;/head&gt;
 &lt;body&gt;
 &lt;div id=&quot;graphdiv&quot;&gt;&lt;/div&gt;
@@ -69,7 +69,7 @@
 &lt;html&gt;
 &lt;head&gt;
 &lt;script type=&quot;text/javascript&quot;
-  src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
+  src=&quot;dygraph-combined-dev.js&quot;&gt;&lt;/script&gt;
 &lt;/head&gt;
 &lt;body&gt;
 &lt;div id=&quot;graphdiv2&quot;
 &lt;html&gt;
 &lt;head&gt;
 &lt;script type=&quot;text/javascript&quot;
-  src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
+  src=&quot;dygraph-combined-dev.js&quot;&gt;&lt;/script&gt;
 &lt;/head&gt;
 &lt;body&gt;
 &lt;div id=&quot;graphdiv3&quot;
index d73fcc4..0d6760e 100755 (executable)
@@ -150,7 +150,7 @@ def urlify_gallery(f):
 
 
 for label in sorted(labels):
-  print '<a name="%s"><h3>%s</h3>\n' % (label, label)
+  print '<a name="%s"></a><h3>%s</h3>\n' % (label, label)
 
   for opt_name in sorted(docs.keys()):
     opt = docs[opt_name]
@@ -181,7 +181,9 @@ for label in sorted(labels):
     if not opt['description']: opt['description'] = '(missing)'
 
     print """
-  <div class='option'><a name="%(name)s"></a><b>%(name)s</b><br/>
+  <div class='option'><a name="%(name)s"></a><b>%(name)s</b>
+  <a class="link" href="#%(name)s">#</a>
+  <br/>
   <p>%(desc)s</p>
   <i>Type: %(type)s</i><br/>%(parameters)s
   <i>Default: %(default)s</i></p>