This page describes the conventions and tags used in the WordPress Arctos documentation. It’s not going to be very instructive unless you’re looking at the edit HTML view. If you can’t see that then this isn’t for you anyway, so ha.
this thing….
top
…just hangs out there, off to the left. It doesn’t matter where you put it, because that’s just how it rolls. It may be a stupid idea anyway.
The first thing on every page should be an anchor named “top”:
Next is the page-nav div. Don’t forget closing tags.
Content goes down here.
bla
bla
stuff
There’s no reason to have an anchor on the first block of text.
Top
Now, we’re down far enough that anchors are beneficial.
The anchor is also a hyperlink to anchor #top.
Bla bla bla
SomeDataType nullable
above is a field definition – given the anchor name, it should be for field “anchor2.” Note the spacing and order – important for WordPress’s half-baked pseudoHTML-thingee.
Said half-baked thingee loves fracking up links, so watch for things like
Note the linked text is now magically outside the tag. Sweet. Something about switching back and forth between “visual” and “html” editing, maybe. Or sunspots.
Top
Yet another anchor. You can link to anchored WordPress content by
http://theBaseUrl.com/any/directory/structure/#anchor1 – e.g,
or locally – within the current page, with simply #anchor1
Top
Codetables is going to get the bold treatment. Spiffy, and probably how these things should all look.
Do NOT discuss code table values in this documentation – that belongs only in the documentation field of the table itself. Instead, link to that, like this:
And then, only if necessary, elaborate on anything that cannot be fully described in the code table.
