diff options
Diffstat (limited to '_nav/README.md')
| -rw-r--r-- | _nav/README.md | 69 |
1 files changed, 51 insertions, 18 deletions
diff --git a/_nav/README.md b/_nav/README.md index d7bd19b86..8e0fd4d1c 100644 --- a/_nav/README.md +++ b/_nav/README.md @@ -5,36 +5,42 @@ 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: -> ```<script src="//www.mageia.org/_nav/js/"></script> +> ```<script src="//nav.mageia.org/js/"></script> > ``` It will: * load the stylesheet rules * detect some of your document features; -* build a ```<div id="nav" />``` node just after the <body> of your doc; +* 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. -* ```//www.mageia.org/_nav/css/``` -* ```//www.mageia.org/_nav/html/?l={html[lang]}&b={body[class]}&w=1``` +* ```//nav.mageia.org/css/``` +* ```//nav.mageia.org/html/?l={html[lang]}&b={body[class]}&w=1``` +and: +* publish CSS in your documents. +* put HTML in ```<div id="nav" />``` just after the ```<body>``` + of your doc + +--- ## Update your documents HTML & CSS -You need to change your CSS rules so that they match: +In both cases, you need to change your CSS rules so that they match: > ``` > html, body { margin: 0; padding: 0; } @@ -57,7 +63,7 @@ at the top of your HTML document: > ```<body> > <h1 id="mgnavt">your title</h1>``` - +--- ## Features The detected and used features are: @@ -68,13 +74,40 @@ 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/www/trunk/_nav/](http://svn.mageia.org/web/www/trunk/_nav/) -* written by [Romain d'Alverny](http://twitter.com/rdalverny) in April 2012 -* licensed under GNU GPL-2+. +* code is in [svn://svn.mageia.org/svn/web/nav/](http://svn.mageia.org/web/nav/) +* licensed under GNU GPL-3+, 2012, rda +* 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) -----
\ No newline at end of file +--- +## TODO + +* [FIXED, 2012/06/11] no cache on the service (speeding up delivery) +* [PARTIAL] jumping page when the bar is loaded: + - fixed for: forum, wiki/Vector; + - the bar still slides, but the page is already at the right place, with a fixed position from top; quick example: + + html, body { margin: 0; padding: 0; } + #wrap { margin-top: 80px; } + #hmgn { position: absolute; top: 0; left: 0; width: 100%; } + +* navbar still to deploy on: planet, mailing-lists +* needs some work: blog, wiki (switch to Vector) +* nav bar won't fix/resize depending on screen resolution => use CSS media queries +* no cache wrapper/library available for client apps +* [?] nav bar design and branding ugly +* [?] nav bar too big + +* analytics for forum + +* wiki media queries + +### Issues + + * [WONTFIX] when using the JS service, no fallback for browsers with no Javascript + * + +---- |