Notes
Some examples of note boxes:
Note: This is a note. It's useful or important information but not critical.
Notes may include other stuff too:
Note: If you have trouble with this, you may need to do the following
foo.doStuff();
if (bar) {
baz();
}
Warnings
Warnings present information that needs to be considered or bad things may happen:
Warning: If you don't do this right, the Universe will explode. See Some page or other for details.
These, too, may include other stuff like code samples or tables.
More details
We don't actually have this yet. This is something that we need to define. The idea is for this to be an expandable or togglable box that contains information that most readers won't need but might be of interest to specific users. We're really open to how this should look and work.
This would be useful for things like:
- Presenting information about older versions of a product. Click a button or heading or something to expand a box that describes how to use an obsolete function.
- Presenting advanced information. Label the box expander with "In depth" and it expands to present details about the way a technology works that isn't of use to the average reader. "This API works by connecting the nsIFoo interface with the nsIBar interface then communicating with the server using WebSockets. You don't need to know how this works, because it just works, but here are diagrams and explanations all about it."