Restructure a bit and add a couple of pages of documentation #10
Conversation
docs/maps/mapml-viewer.md
Outdated
|
|
||
| ```html | ||
| <!DOCTYPE html> | ||
| <html> |
There was a problem hiding this comment.
Please add lang="en" to the HTML element.
| <html> | ||
| <head> | ||
| <title>A Simple Web Map[tm]</title> | ||
| <meta charset="utf-8" /> |
There was a problem hiding this comment.
<meta charset="utf-8"> must exist in the first 1024 byte of a document, as such it is a best practice to specify it as the first element in <head>, and since people might copy and paste this we should adhere to that.
There was a problem hiding this comment.
I also recommend setting <meta name="viewport" content="width=device-width, initial-scale=1">, as almost everybody is going to want to build a responsive page.
docs/maps/mapml-viewer.md
Outdated
| <title>A Simple Web Map[tm]</title> | ||
| <meta charset="utf-8" /> | ||
| <script type="module" src="web-map/mapml-viewer.js"></script> | ||
| <style>html {height:100%} * {margin:0px;padding:0px} body,mapml-viewer {height:inherit}</style> |
There was a problem hiding this comment.
These styles aren't required, can we remove them?
There was a problem hiding this comment.
Ideally we'd encourage people to use the pre-styling styles to avoid layout shifts and FOUC, and the <noscript> styles if they want to use fallbacks. But maybe we should deal with that as a separate issue.
docs/maps/mapml-viewer.md
Outdated
|
|
||
| - `APSTILE` is based on the Alaska Polar Stereographic (EPSG:5936) projected coordinate reference system, and has 20 zoom levels (0 to 19). | ||
|
|
||
| - other projections are possible, using the "[Custom Projections](https://github.com/Maps4HTML/Web-Map-Custom-Element/pull/239/commits/e9a29e7abcc43d7f15eb64729920e2ad06fc25c5)" API |
There was a problem hiding this comment.
Alternatively this link could point to the file at https://github.com/Maps4HTML/Web-Map-Custom-Element/blob/master/demo/CustomProjection.html (instead of the PR commit).
|
|
||
| The web-map custom element suite provides a set of proof-of-concept "[customized built-in](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements)" elements based on `<map>`, `<area>` and `<img>` that will "fall back" to a client side image map in older browsers, or in the absence of JavaScript (scripting disabled). | ||
|
|
||
| Note that because not all modern Web browsers implement HTML's customized built-in elements, it is not recommended to use this proof-of-concept on a public Web site, as end-user confusion may be the result. |
There was a problem hiding this comment.
This document as a whole scares me 😅. Can we make this paragraph into an alert box, similar to the one at https://maps4html.org/web-map-doc/docs/layers/static-images/?
There was a problem hiding this comment.
Yeah it's a sad story!
There was a problem hiding this comment.
These are good changes, it may be valuable to make the first few pages users interact with less intimidating by linking to text heavy content rather than keeping it inline but that's your decision to make. Also I know personally when looking at documentation the less content the better generally, as you tend to skim through things anyways but that might just be a personal preference.
No, I agree with these! That's why I asked for a review! 💯 |
Let me know if you have any comments, please, and thanks!