aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRomain d'Alverny <rda@mageia.org>2012-06-05 21:34:24 +0000
committerRomain d'Alverny <rda@mageia.org>2012-06-05 21:34:24 +0000
commit92bf9304e8626c66c7cb63eebd33742dbdbecb4f (patch)
treeb7f4ec58bd8c3f8d8207bede327efc6e91c15127 /README.md
parentf434b255badbdb7e261078bbc24cba6d2ea4f13f (diff)
downloadnav-92bf9304e8626c66c7cb63eebd33742dbdbecb4f.tar
nav-92bf9304e8626c66c7cb63eebd33742dbdbecb4f.tar.gz
nav-92bf9304e8626c66c7cb63eebd33742dbdbecb4f.tar.bz2
nav-92bf9304e8626c66c7cb63eebd33742dbdbecb4f.tar.xz
nav-92bf9304e8626c66c7cb63eebd33742dbdbecb4f.zip
new notes
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 36 insertions, 11 deletions
diff --git a/README.md b/README.md
index 924af89..92be448 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,11 @@ a same, consistent looking, synchronized navigation bar.
You have two ways to use this service:
-* using a Javascript snippet;
-* using directly CSS and HTML and placing them at the right place.
+1. using a Javascript snippet;
+1. using directly CSS and HTML and placing them at the right place.
-
-## Use a Javascript snippet (preferred, less work)
+---
+## 1. Use a Javascript snippet (preferred, less work)
Place this at the end of your HTML document:
@@ -23,8 +23,8 @@ It will:
* build a ```<div id="nav" />``` node just after the ```<body>``` of your doc;
* call and inject the HTML.
-
-## Use directly HTML & CSS
+---
+## 2. Use directly HTML & CSS
Get, and _cache_ those two document and insert them in your HTML.
@@ -37,8 +37,7 @@ and:
* put HTML in ```<div id="nav" />``` just after the ```<body>```
of your doc
-----
-
+---
## Update your documents HTML & CSS
In both cases, you need to change your CSS rules so that they match:
@@ -64,7 +63,7 @@ at the top of your HTML document:
> ```<body>
> <h1 id="mgnavt">your title</h1>```
-
+---
## Features
The detected and used features are:
@@ -75,8 +74,7 @@ The detected and used features are:
* ```head > meta[name="context"] value``` is not used yet.
* ```document.location.href``` is used for stats purpose (logs).
-
-
+---
## Code & license
* code is in [svn://svn.mageia.org/svn/web/nav/](http://svn.mageia.org/web/nav/)
@@ -84,4 +82,31 @@ The detected and used features are:
* issues on [bugs.mageia.org](https://bugs.mageia.org/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&component=nav.mageia.org&product=Websites)
* patches and discussions welcome in [Mageia Web team](https://wiki.mageia.org/en/Web_team)
+---
+## TODO
+
+* [?] nav bar not entirely deployed: identity, wiki, all forums,
+* [?] nav bar design and branding ugly
+* [?] nav bar too big
+* nav bar won't fix/resize depending on screen resolution => use CSS media queries
+* no cache on the service (speeding up delivery)
+* no cache wrapper/library available for client apps
+
+
+jumping page when the bar is loaded: fixed on this forum; the bar still slides, but the page is already at the right place. I will check later (on the road now) how to deploy this in the service itself:
+
+ html, body { margin: 0; padding: 0; }
+ #wrap { margin-top: 80px; }
+ #hmgn { position: absolute; top: 0; left: 0; width: 100%; }
+
+
+* analytics for forum
+
+* wiki media queries
+
+### Issues
+
+ * [WONTFIX] when using the JS service, no fallback for browsers with no Javascript
+ *
+
----