Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
A skeleton for the docs; contents hierarchy
#2 Wrote:I suggest to use the FreeBASIC docs as a guide, especially the FreeBASIC Table of Contents. What do you think?
That was (more or less) what I was doing in the main ZX Basic doc page: <!-- m --><a class="postlink" href=""></a><!-- m --> (this is just an alias).
BTW, if someone enters documentation in the wiki, *remember* you must use ZX_BASIC: prefix as name space (just see your brower URL location when reading any ZX Basic wiki article). Wrote:By the way, I see a problem about FreeBASIC wiki: it lacks page hierarchy, it doesn't show a breadcrumb on the top, what is very important to see where we are in the page tree. Many wikis lack that feature. Some of them use the raw page name (e.g. "main.reference.functions" would be a deeper level than "main.reference"); others use page metadata to configure the hierarchy (what is more flexible because page names can change without changing the structure).

Another possible model is the PHP documentation (see an example of PHP doc page): description, parameters, return values, examples, see also, user contributions...

The main problem with FreeBasic Wiki, ZX Basic one and most of the others is they lack a "navigation" template. I know how to make a basic template, but not a useful one, with mediaWiki. Still studying it. :roll: Because there are very useful pages, such us a categories one:
<!-- m --><a class="postlink" href=""> ... Categories</a><!-- m --> or even better, a hierarchical tree of related pages (I think there's a MediaWiki plugin for it).

Messages In This Thread

Forum Jump:

Users browsing this thread: 1 Guest(s)