From BlenderWiki

Jump to: navigation, search

User's documentation Structure (Doc:)


Guidelines

  • These pages describe Blender functionalities to the user.
  • They have a leadling "Doc:", which is the Doc namespace.
  • Each part is divided into sections, like Modeling, Data System, Lights, and so on. It is important that we keep the same structure inside each part so that we'll be able to crosslink them.
Example: Doc:Tutorials/Modifiers <==> Doc:Manual/Modifiers

Index

Current Blender version (2.6) 2.4
Doc:2.6/Manual/... Doc:2.4/Manual/...
Doc:2.6/Tutorials/... Doc:2.4/Tutorials/...
Doc:2.6/Reference/... Doc:2.4/Reference/...
Doc:2.6/FAQ/... Doc:2.4/FAQ/...
Doc:2.6/Books/... Doc:2.4/Books/...


Developer's documentation Structure (Dev:)


Guidelines

  • These pages are to help developers to describe project functionality as it is implemented.
  • The leading "Dev:" refers to the Dev namespace.
  • Each page can be found with or without Blender version (they will be crosslinked):
    • Dev:Source/Foo
    • Dev:2.5/Source/Foo
If the Blender version is not specified it applies to all Blender versions.
If the Blender version is specified then the code described in that page is specific to that version.
  • Each part should be divided into sections, like Modeling, Data System, Lights, and so on. It is important that we keep the same structure inside each part so that we'll be able to crosslink them.
Example: Dev:Source/Modifiers <==> Doc:Manual/Modifiers

Index

Use Not specific 2.5 specific 2.4 specific
General index Dev:Contents Dev:2.5 Dev:2.4
Blender development documentation Dev:Doc Dev:2.5/Doc Dev:2.4/Doc
Blender source code documentation Dev:Source Dev:2.5/Source Dev:2.4/Source
Python scripts development documentation Dev:Py Dev:2.5/Py Dev:2.4/Py
Reference development documents Dev:Ref - -
Release notes Dev:Ref/Release Notes - -
Google summer of code projects Dev:Ref/GSoC - -
Feature requests Dev:Ref/Requests - -


Extensions documentation Structure (Extensions:)


Guidelines

  • These pages contain the extensions (scripts and plugins) documentation.
  • They have a leading "Extensions:", which is the Extensions namespace.
  • Each page can be found with or without Blender version (they will be crosslinked):
    • Extensions:Py
    • Extensions:2.5/Py
The one without the Blender version refers to code that is not specific (or, more probably, it is a small index to let the user choose between Blender versions).

Index

Use Not specific 2.6 specific 2.4 specific
General index Extensions:Contents Extensions:2.6 Extensions:2.4
Python general index Extensions:Py Extensions:2.6/Py Extensions:2.4/Py
Py Scripts Extensions:Py/Scripts Extensions:2.6/Py/Scripts Extensions:2.4/Py/Scripts
Py Nodes Extensions:Py/Nodes - Extensions:2.4/Py/Nodes
Plugins index Extensions:Plugins - Extensions:2.4/Plugins


Wiki writer's Documentation Structure (Meta:)


Guidelines

  • These pages deal with the wiki itself: its usage, development and standards.
  • The leading "Meta:" refers to the Meta namespace.

Index

Use Not specific 2.5 specific 2.4 specific
General index Meta:Contents Meta:2.5 Meta:2.4
Guides Meta:Guides - -
Tasks Meta:Wiki_Tasks Meta:2.5/Wiki_Tasks Meta:2.4/Wiki_Tasks
Sandbox (test pages) Meta:Sandbox - -
Tools for wiki maintenance Meta:Tools - -