Documentation Taxonomy: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
m (Reverted edit of Sktokxoz, changed back to last version by Magicdice)
 
(14 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Status ==
== 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 ==
== 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) ==
== Taxonomy List (rough) ==
 
=== External Standards ===
; Accessibility : Assistive technologies and related development efforts.
 
; AOM : Application Object Model.
 
; CSS : Cascading Style Sheets.
; 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."
; 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."


; Embedding Mozilla : Embeddable browser and HTML editor SDK.
; HTML : Hypertext Markup Language.
 
; JavaScript : Scripting language.


; Extensions : Small add-ons for extending the functionality of Mozilla applications.
; RDF : Resource Description Framework, W3C technology.


; Gecko : Browser engine.
; Web Standards : Web standards, best practices, using standards in web development, etc.


; HTML : Hypertext Markup Language.
; SVG : Scalable Vector Graphics


; JavaScript : Scripting language.
; XML : Extensible Markup Language.


; Layout : ???
; XSLT : XSL Transformations language.


; Mozilla as a Platform : Developing applications using the Mozilla platform.
=== Internal ===
; AOM : Application Object Model.


; Mozilla Hacking : Developing Mozilla technologies.
; Gecko : Browser engine.


; Necko (?) : "The network library (Necko) provides a platform-independent API for several layers of networking ranging from transport to presentation layers. This API is used in the Mozilla client and can be used for writing other networking clients."
; Necko (?) : "The network library (Necko) provides a platform-independent API for several layers of networking ranging from transport to presentation layers. This API is used in the Mozilla client and can be used for writing other networking clients."
Line 45: Line 42:
; NSPR : "Netscape Portable Runtime (NSPR) provides a platform-neutral API for system level and libc like functions. The API is used in the Mozilla client, many of Netscape/AOL/iPlanet's and other software offerings."
; NSPR : "Netscape Portable Runtime (NSPR) provides a platform-neutral API for system level and libc like functions. The API is used in the Mozilla client, many of Netscape/AOL/iPlanet's and other software offerings."


; Open Source Development : Open Source development practices and such.
; XBL : Extensible Binding Language, used in describing bindings that can be attached to elements in other documents. 
 
; XPCOM : Cross Platform Component Object Model. 
 
<!-- ; XPFE : ... -->
; XPInstall : Cross Platform Installer (presumably).


; Plugins : Plugin development docs.
; XPToolkit : ...


; RDF : Resource Description Framework, W3C technology.
; XUL : XML User Interface Language.


; Remote Applications : Development of remote applications.
=== Aspects ===


; Scripting : General topic, not sure if this belongs on the list.
; Accessibility : Assistive technologies and related development efforts.


; Security : Anything and everything related to security technologies in Mozilla.
; Embedding Mozilla : Embeddable browser and HTML editor SDK.


; Testing (QA, etc) : Docs related to QA, testing, bug reporting, etc.
; Extensions : Small add-ons for extending the functionality of Mozilla applications.


; Themes : Theme development docs.
; Internationalization : ???


; Toolkit Apps : ...
; Localisation : ???


; Tools : Any documentation related to development tools such as Bugzilla, Bonsai, LXR, etc.
; Mozilla as a Platform : Developing applications using the Mozilla platform.


; Web Standards : Web standards, best practices, using standards in web development, etc.
; Mozilla Hacking : Developing Mozilla technologies.


; XBL : Extensible Binding Language, used in describing bindings that can be attached to elements in other documents.
; Open Source Development : Open Source development practices and such.


; XML : Extensible Markup Language.
; Plugins : Plugin development docs.


; XPCOM : Cross Platform Component Object Model.
; Remote Applications : Development of remote applications.


; XPInstall : Cross Platform Installer (presumably).
; Scripting : General topic, not sure if this belongs on the list.


; XSL : Extensible Stylesheet Language.
; Security : Anything and everything related to security technologies in Mozilla.


; XSLT : XSL Transformations language.
; Testing (QA, etc) : Docs related to QA, testing, bug reporting, etc.


; XPToolkit : ...
; Themes : Theme development docs.


; XUL : XML User Interface Language.
; Toolkit Apps : Dev docs related to Firefox, Calendar, Thunderbird.


; Tools : Any documentation related to development tools such as Bugzilla, Bonsai, LXR, etc.


== Other Stuff ==
== Other Stuff ==

Latest revision as of 10:41, 25 November 2006

Status

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

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.

That said, PLEASE feel free to modify, organize, and add to the list below.

You may want to have a look at http://www.mozilla.org/docs/jargon.html

Taxonomy List (rough)

External Standards

CSS
Cascading Style Sheets.
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."
HTML
Hypertext Markup Language.
JavaScript
Scripting language.
RDF
Resource Description Framework, W3C technology.
Web Standards
Web standards, best practices, using standards in web development, etc.
SVG
Scalable Vector Graphics
XML
Extensible Markup Language.
XSLT
XSL Transformations language.

Internal

AOM
Application Object Model.
Gecko
Browser engine.
Necko (?)
"The network library (Necko) provides a platform-independent API for several layers of networking ranging from transport to presentation layers. This API is used in the Mozilla client and can be used for writing other networking clients."
NSPR
"Netscape Portable Runtime (NSPR) provides a platform-neutral API for system level and libc like functions. The API is used in the Mozilla client, many of Netscape/AOL/iPlanet's and other software offerings."
XBL
Extensible Binding Language, used in describing bindings that can be attached to elements in other documents.
XPCOM
Cross Platform Component Object Model.
XPInstall
Cross Platform Installer (presumably).
XPToolkit
...
XUL
XML User Interface Language.

Aspects

Accessibility
Assistive technologies and related development efforts.
Embedding Mozilla
Embeddable browser and HTML editor SDK.
Extensions
Small add-ons for extending the functionality of Mozilla applications.
Internationalization
???
Localisation
???
Mozilla as a Platform
Developing applications using the Mozilla platform.
Mozilla Hacking
Developing Mozilla technologies.
Open Source Development
Open Source development practices and such.
Plugins
Plugin development docs.
Remote Applications
Development of remote applications.
Scripting
General topic, not sure if this belongs on the list.
Security
Anything and everything related to security technologies in Mozilla.
Testing (QA, etc)
Docs related to QA, testing, bug reporting, etc.
Themes
Theme development docs.
Toolkit Apps
Dev docs related to Firefox, Calendar, Thunderbird.
Tools
Any documentation related to development tools such as Bugzilla, Bonsai, LXR, etc.

Other Stuff

  • Cross References
  • Image Handling
Retrieved from "https://wiki.allizom.org/index.php?title=Documentation_Taxonomy&oldid=43146"