Documentation > Changelog
This page is not intended for user/developers. Here I keep track of what I have done to the docs, eg. removing/adding/updating sections.
>> kanesodi >>
- code must be inside code tag
- notes must use indent tag
- when referred to a page which can be configured by a user/admin it must be italic. examples are site.config and site.auth
- each page should look like
- checked all doc.concept pages
- docs.concepts.hg, examples last section
- replace table with code?
- docs.concepts.lists is empty
- removed >> NEXT >> from Other System Settings in docs.admin.config
- needs to be expanded
- cleaned up "Root and field wikis live together" in docs.admin.farms
- changed url's on docs.admin
- <code> is invalid?</code>
Yes. The syntax has been changed to [[.siteconfig]] or [[..site.config]]... Leading dot's mean same hierarchy as current page.
Pages need more details, contributions, tutorial
Think about using the word "tutorial" while it point to another doc page. doc page is _not_ a tutorial?
What is tutorial?
Define tutorial, BoltWire style
How should a tutorial be different from doc?Looks? Style? Text?
- text: username of contributer should be added
- text: including email (optional)
field as in html forms and field as in BoltWire /field.
html field is a established name, changing it is not an option. changing /field is easy, since it doesn't interfere with BoltWire workings.
what is the best solution to overcome confusion?
- change name of /field.
- clear names: main, sub, home
- animal-part names: leg, arm, tentical, bugleg
- environment names: railway, highway, galaxy, tractor, wheel, needle
- animal name: cow, sheep, chicken
- synonym of field: area, corral, space, paddock, parcel, land, pasture, pen, tract
- different color in docs for /field?
- small icon in front of the word "field" when referring to BoltWire /field and none when referring to html field
3 pretty names
users should be able to turn off pretty names for site.config so while reading docs they can quickly find the corresponding page. In docs site.config, action.backup, template.toc is used, while default installation shows Configuration, Backup, Toc.
For docs to point directly to appropiate page the explaination should be:This x can be configured via Site/Configuration
But that means changing entire docs, replacing text. Which is an option, but another thing comes up, namely reading-comfort.
Compare following 2 examples of same text.You can configure indexing setting indexing to active in Site/Configuration. To have a page indexed for search to work you need to put [[(index)]] markup in your pages. It is recommended to Use Site/Cron Jobs to speed up your website. You can configure indexing by setting indexing to active in site.config. To have a page indexed for search to work you need to put [[(index)]] markup in your pages. It is recommended to Use site.cron to speed up your website.
The latter is easier to read and write, imho. And because all pages used in default BoltWire installation are written in italic a user knows what is meant. Another thing is that it's much more efficient to seperate site.cron from Cron you can configure via server. Some users might not be able to configure their server but can be easily confused which kind of cron is meant.