Difference between revisions of "Categories"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Trying to sort and clean up categories.)
 
m (Added links. Added DPL example.)
Line 1: Line 1:
−
Categories used in the Wiki,
+
Types of categories used in the Wiki,
 
* absolute categories,
 
* absolute categories,
−
* relative categories.
+
* generic categories.
  
−
==Absolut Categories==
+
==Absolute Categories==
−
{{:Uno/Term/Effort}}
+
Any article has a "is-a" relationship to a particular absolute category. E.g. an article is-a tutorial, or is-a specification etc. Therefore categories are in '''singular'''. Current used absolute categories are:
−
;[[:Category:Spec]] : Code specifications.
+
;[[:Category:Effort]]: An effort to change a particular aspect of OOo. E.g. [[Effort/Revise_OOo_Multi-Threading|Revise OOo Multi-Threading]].
−
;[[:Category:Specification]] : (G)UI specifications.
+
;[[:Category:Spec]] : Code (e.g. C/C++ headers) or structural specifications. E.g. [[Uno/Spec/Cascaded_Mapping|Cascaded Mapping]].
−
;[[:Category:Proposal]]:
+
;[[:Category:Specification]] : (G)UI specifications. E.g. [[Test_case_specification|Test case specification]].
−
;[[:Category:Article]]:
+
;[[:Category:Proposal]]: Articles proposing a change, leading to an [[Uno/Term/Effort|Effort]]. E.g. [[Proposal/Advanced Threading-Architecture|Advanced Threading-Architecture]].
−
;[[:Category:Art]]:
+
;[[:Category:Article]]: Something informative. E.g. [[Uno/Article/Understanding_Uno|Understanding Uno]].
−
;[[:Category:Draft]]:
+
;[[:Category:Draft]]: Something not finished yet. E.g. [[Uno/Spec/Threading-Model|Threading-Model]]
−
;[[:Category:FAQ]]:
+
;[[:Category:FAQ]]: Frequently Asked Question(s). E.g. [[API/FAQ|API FAQ]].
−
;[[:Category:To-Do]]:
+
;[[:Category:To-Do]]: Something to be done. E.g. [[Framework/To-Dos|Framework To-Dos]].
−
;[[:Category:Tutorial]]:
+
;[[:Category:Tutorial]]: Article teaching something. E.g. [[Tutorial_Writer|Writer Tutorial]].
−
;[[:Category:How To]]:
+
;[[:Category:How to]]: A receipt to solve a particular problem. E.g. [[Windows_Tips|Windows Tips]].
−
;[[:Category:Impl]]:
+
;[[:Category:Impl]]: A description of a particular implementation. E.g. [[Uno/Cpp/Impl/FreeReference|C++ Uno FreeReference]].
−
;[[:Category:Test]]:
+
;[[:Category:Test]]: A (unit) test for a particular implementation. E.g. [[Uno/Cpp/Test/Cpp-Uno_Bridge|C++ Uno Bridge]].
−
;[[:Category:Module]]:
+
;[[:Category:Module]]: A page describing the organization of a particular source code module. E.g. [[Uno/Cpp/Module/CPPUhelper|C++ Uno CPPUhelper]].
−
;[[:Category:ModuleTest]]:
+
;[[:Category:ModuleTest]]: Description of how to test a particular source code module. E.g. [[Uno/Cpp/Module/CPPUhelper/test|C++ Uno CPPUhelper test]].
−
;[[:Category:Project]]:
+
;[[:Category:Project]]: Entry page for an accepted OOo project. E.g. [[ODF_Toolkit|the ODF Toolkit]].
−
;[[:Category:Analysis]]:
+
;[[:Category:Analysis]]: Document analysing a particular aspect of OOo. E.g. [[Architecture/Process_Flow|Process Flow]].
  
 
==Generic Categories==
 
==Generic Categories==
−
; Project: E.g [[:Category:API, [[:Category:Architecture, [[:Category:Uno, [[:Category:VCL, [[:Category:Database, [[:Category:Marketing, [[:Category:Framework]], [[:Category:Tools]], [[:Category:Porting]], [[:Category:Impress]], [[:Category:Writer]], [[:Category:QA]], [[:Category:Util]], [[:Category:Chart2]], ...
+
; Project: E.g [[:Category:API]], [[:Category:Architecture]], [[:Category:Uno]], [[:Category:VCL]], [[:Category:Database]], [[:Category:Marketing]], [[:Category:Framework]], [[:Category:Tools]], [[:Category:Porting]], [[:Category:Impress]], [[:Category:Writer]], [[:Category:QA]], [[:Category:Util]], [[:Category:Chart2]], ...
−
; Programming Language: Cpp, Macros, Java, CLI
+
; Programming Language: [[:Category:Cpp]], [[:Category:Macros]], [[:Category:Java]], [[:Category:CLI]]
 
; Rule: Coding Standards, Guidelines
 
; Rule: Coding Standards, Guidelines
 
; Keyword: Eclipse
 
; Keyword: Eclipse
 +
 +
==Queries==
 +
Absolute and generic categories may be combined in an independent way. E.g. a tutorial about something in the [[Uno]] project may have the categories '''Tutorial''' and '''Uno'''. To show all Uno tutorials the DPL (Dynamic Page List) extension is handy. E.g.
 +
<pre>
 +
<DPL>
 +
  category=Uno
 +
  category=Tutorial
 +
</DPL>
 +
</pre>
 +
gives
 +
<DPL>
 +
  category=Uno
 +
  category=Tutorial
 +
</DPL>

Revision as of 09:16, 7 February 2007

Types of categories used in the Wiki,

  • absolute categories,
  • generic categories.

Absolute Categories

Any article has a "is-a" relationship to a particular absolute category. E.g. an article is-a tutorial, or is-a specification etc. Therefore categories are in singular. Current used absolute categories are:

Category:Effort
An effort to change a particular aspect of OOo. E.g. Revise OOo Multi-Threading.
Category:Spec 
Code (e.g. C/C++ headers) or structural specifications. E.g. Cascaded Mapping.
Category:Specification 
(G)UI specifications. E.g. Test case specification.
Category:Proposal
Articles proposing a change, leading to an Effort. E.g. Advanced Threading-Architecture.
Category:Article
Something informative. E.g. Understanding Uno.
Category:Draft
Something not finished yet. E.g. Threading-Model
Category:FAQ
Frequently Asked Question(s). E.g. API FAQ.
Category:To-Do
Something to be done. E.g. Framework To-Dos.
Category:Tutorial
Article teaching something. E.g. Writer Tutorial.
Category:How to
A receipt to solve a particular problem. E.g. Windows Tips.
Category:Impl
A description of a particular implementation. E.g. C++ Uno FreeReference.
Category:Test
A (unit) test for a particular implementation. E.g. C++ Uno Bridge.
Category:Module
A page describing the organization of a particular source code module. E.g. C++ Uno CPPUhelper.
Category:ModuleTest
Description of how to test a particular source code module. E.g. C++ Uno CPPUhelper test.
Category:Project
Entry page for an accepted OOo project. E.g. the ODF Toolkit.
Category:Analysis
Document analysing a particular aspect of OOo. E.g. Process Flow.

Generic Categories

Project
E.g Category:API, Category:Architecture, Category:Uno, Category:VCL, Category:Database, Category:Marketing, Category:Framework, Category:Tools, Category:Porting, Category:Impress, Category:Writer, Category:QA, Category:Util, Category:Chart2, ...
Programming Language
Category:Cpp, Category:Macros, Category:Java, Category:CLI
Rule
Coding Standards, Guidelines
Keyword
Eclipse

Queries

Absolute and generic categories may be combined in an independent way. E.g. a tutorial about something in the Uno project may have the categories Tutorial and Uno. To show all Uno tutorials the DPL (Dynamic Page List) extension is handy. E.g. 

<DPL>
  category=Uno
  category=Tutorial
</DPL>

gives

Retrieved from "https://wiki.openoffice.org/w/index.php?title=Categories&oldid=24548"
Personal tools