5 |
|
|
6 |
You have two ways to use this service: |
You have two ways to use this service: |
7 |
|
|
8 |
* using a Javascript snippet; |
1. using a Javascript snippet; |
9 |
* using directly CSS and HTML and placing them at the right place. |
1. using directly CSS and HTML and placing them at the right place. |
10 |
|
|
11 |
|
--- |
12 |
## Use a Javascript snippet (preferred, less work) |
## 1. Use a Javascript snippet (preferred, less work) |
13 |
|
|
14 |
Place this at the end of your HTML document: |
Place this at the end of your HTML document: |
15 |
|
|
23 |
* 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; |
24 |
* call and inject the HTML. |
* call and inject the HTML. |
25 |
|
|
26 |
|
--- |
27 |
## Use directly HTML & CSS |
## 2. Use directly HTML & CSS |
28 |
|
|
29 |
Get, and _cache_ those two document and insert them in your HTML. |
Get, and _cache_ those two document and insert them in your HTML. |
30 |
|
|
37 |
* put HTML in ```<div id="nav" />``` just after the ```<body>``` |
* put HTML in ```<div id="nav" />``` just after the ```<body>``` |
38 |
of your doc |
of your doc |
39 |
|
|
40 |
---- |
--- |
|
|
|
41 |
## Update your documents HTML & CSS |
## Update your documents HTML & CSS |
42 |
|
|
43 |
In both cases, 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: |
63 |
> ```<body> |
> ```<body> |
64 |
> <h1 id="mgnavt">your title</h1>``` |
> <h1 id="mgnavt">your title</h1>``` |
65 |
|
|
66 |
|
--- |
67 |
## Features |
## Features |
68 |
|
|
69 |
The detected and used features are: |
The detected and used features are: |
74 |
* ```head > meta[name="context"] value``` is not used yet. |
* ```head > meta[name="context"] value``` is not used yet. |
75 |
* ```document.location.href``` is used for stats purpose (logs). |
* ```document.location.href``` is used for stats purpose (logs). |
76 |
|
|
77 |
|
--- |
|
|
|
78 |
## Code & license |
## Code & license |
79 |
|
|
80 |
* code is in [svn://svn.mageia.org/svn/web/nav/](http://svn.mageia.org/web/nav/) |
* code is in [svn://svn.mageia.org/svn/web/nav/](http://svn.mageia.org/web/nav/) |
82 |
* 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) |
* 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) |
83 |
* patches and discussions welcome in [Mageia Web team](https://wiki.mageia.org/en/Web_team) |
* patches and discussions welcome in [Mageia Web team](https://wiki.mageia.org/en/Web_team) |
84 |
|
|
85 |
|
--- |
86 |
|
## TODO |
87 |
|
|
88 |
|
* [?] nav bar not entirely deployed: identity, wiki, all forums, |
89 |
|
* [?] nav bar design and branding ugly |
90 |
|
* [?] nav bar too big |
91 |
|
* nav bar won't fix/resize depending on screen resolution => use CSS media queries |
92 |
|
* no cache on the service (speeding up delivery) |
93 |
|
* no cache wrapper/library available for client apps |
94 |
|
|
95 |
|
|
96 |
|
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: |
97 |
|
|
98 |
|
html, body { margin: 0; padding: 0; } |
99 |
|
#wrap { margin-top: 80px; } |
100 |
|
#hmgn { position: absolute; top: 0; left: 0; width: 100%; } |
101 |
|
|
102 |
|
|
103 |
|
* analytics for forum |
104 |
|
|
105 |
|
* wiki media queries |
106 |
|
|
107 |
|
### Issues |
108 |
|
|
109 |
|
* [WONTFIX] when using the JS service, no fallback for browsers with no Javascript |
110 |
|
* |
111 |
|
|
112 |
---- |
---- |