Documentation Taxonomy: Difference between revisions

← Older edit

Documentation Taxonomy (view source)

Revision as of 10:41, 25 November 2006

561 bytes removed , 25 November 2006

m

Reverted edit of Sktokxoz, changed back to last version by Magicdice

Mvl

Confirmed users

503

edits

@@ Line 1: / Line 1: @@
 == Status ==
-This page is currently a very early scratch-pad for working up a documentation taxonomy.
+It turns out that formulating a single canonical documentation taxonomy is not necessary, as MediaWiki supports nested Categories, and any page can be included in any number of categories or subcategories.  Having an initial set of categories could still be useful, if only to give us a starting point.
 == Purpose ==
-The purpose of a documentation taxonomy is to provide at least a single, comprehensive, core conceptual structure to the documentation set we will be producing.  Right now the structure is extremely flat -- this is intentional, as the various technologies listed below tend to cross our "audience" borders regularly.  I'm leaving the "root" node off here and listing the rest in discrete topics that are supposed to be relatively self-contained.
+This list exists as an attempt to provide that starting point.  It is less critical that it be correct and complete, however, as Categories and Subcategories (and Sub-subcategories...etc) can be added to a MediaWiki at will.
-I'm thinking that eventually a high level of the taxonomy (not the root, but one or maybe two levels down) will be used to define some custom namespaces within the wiki.  Without having to do any hackery, MediaWiki will support up to 50 custom namespaces (plus 50 related Talk namespaces, for 100 total).  The namespaces will provide flexibility and some basic structure than we would have within a single namespace.
+That said, '''PLEASE feel free to modify, organize, and add to the list below.'''
-Or at least that's my current working theory.  I'll know more after I've had time to mess around with my testwiki.
+You may want to have a look at http://www.mozilla.org/docs/jargon.html
-'''PLEASE feel free to modify the list below -- I'm still familiarizing myself with some of the technologies involved (and am cribbing wildly off lists I've found in various places).  Some of the following may need to be split into separate topics, or some nested within others, others just deleted or added.'''
 == Taxonomy List (rough) ==
@@ Line 17: / Line 15: @@
 ; CSS : Cascading Style Sheets.
-; DHTML : Dynamic HTML.
+; DHTML : Dynamic HTML. (I'm not sure this belongs here. DHTML is a marketing buzzword for JS + HTML; there's no 'DHTML standard' - Gerv)
 ; DOM : "The Document Object Model is an API for HTML and XML documents. It does two things for web developers: it provides a structural representation of the document, and it defines the way that that structure is to be accessed from script, allowing you to get at the web page as a structured group of nodes, which we will discuss shortly. Essentially, it connects web pages to scripts or programming languages."
@@ Line 29: / Line 27: @@
 ; Web Standards : Web standards, best practices, using standards in web development, etc.
-; SVG : ...
+; SVG : Scalable Vector Graphics
 ; XML : Extensible Markup Language.
-; XSL : Extensible Stylesheet Language.
 ; XSLT : XSL Transformations language.
@@ Line 50: / Line 46: @@
 ; XPCOM : Cross Platform Component Object Model.
-; XPFE : ...
+<!-- ; XPFE : ... -->
 ; XPInstall : Cross Platform Installer (presumably).
@@ Line 66: / Line 61: @@
 ; Extensions : Small add-ons for extending the functionality of Mozilla applications.
-; Layout : ???
+; Internationalization : ???
+; Localisation : ???
 ; Mozilla as a Platform : Developing applications using the Mozilla platform.