Yamyam: 1版をインポートしました

2018-06-28T19:47:31Z

1版をインポートしました

wiki>Mont29: /* Automatic information */

2011-10-31T08:41:31Z

‎Automatic information

新規ページ

= Reference project =

== Team ==

* [[User:Mindrones|Mindrones]]
* [[User:Mont29|Mont29]]
* [[User:Ideasman42|Ideasman42]] (hopefully, after reviewing this document :)

== Reference contents ==

* [[#GUI Reference|GUI Reference]]
* [[#RNA Reference|RNA Reference]]

=== GUI Reference ===

For each GUI item (panels, menus, buttons, ...), we list all the related data.

With "data" we intend every kind of information, be it automatic (a tooltip) or human (an example usage).

More about the [[User:Mindrones/Wiki/Proposals/2012/Reference/GUI|GUI reference layout]]

==== Automatic information ====

* Context
*: (necessary conditions for this ui element to work)
*: this is valid especially for properties editor menus/buttons
** object type
** editing mode
** editor type
* Type ''Examples:'' Toggle, Expanding toggle, Radio, Checkbox, Layers, ...
* Label
* Tooltips
* Shortcut
* RNA Operator(s) called by the GUI element, with link to the API documentation. ''Example'': [http://www.blender.org/documentation/blender_python_api_2_60_0/bpy.ops.object.html#bpy.ops.object.duplicate duplicate object] OR RNA Property affected by the GUI element.
* Position of the GUI item in the parent area (where applicable). ''Examples:'' position of a button in the panel, position of a panel in the toolbar, position of the toolbar in the area/editor.

==== Human information ====

* mini tutorial/example
* python snippet
* faq
* gotchas
* used algorithms/formulas
* ...

=== RNA Reference ===

This information is basically already provided in the sphinx Python API documentation.

* Item in the API doc. ''Example'': [http://www.blender.org/documentation/blender_python_api_2_60_0/bpy.ops.object.html#bpy.ops.object.duplicate duplicate object]
* Python snippet

== Reference deployment ==

=== Wiki ===

==== Usage ====

Reference wiki pages would be transcluded into other wiki pages, namely '''Manual pages''', '''Tutorials pages''', or other Reference pages and development pages.

''Examples''

* In a manual page, we want to mention the shortcut to duplicate an object. Typing "press <code><nowiki>{{Ref:GUI/Object/3DView/Object_mode/Shortcuts/Duplicate}}</nowiki></code>" would return "press {{shortcut|shift|D}}"

* In a manual page, hovering over the words "scroll the header" might show a little popup showing how to do it (for current versions of blender, it would be "drag the header with the {{shortcut|MMB}}").

{{Note|Note well|By doing this, if shortcuts and commands will change, we won't need to update manual pages anymore, because mediawiki will update every page which transcludes the now modified reference pages.}}

==== Tools for writers ====

Very probably, reference will contain hundreds of pages. How to find a desidered reference page?

# we would show them in the navtree:
#* when reading reference pages, as usual
#* '''but also when editing pages in wiki, in the sidebar on the right'''
# we add the chance to copy a button reference wikitext in blender:
#* hovering on a blender GUI item. right click, choose "copy wiki reference url"
#* this would put the text <code><nowiki>{{Ref:GUI/Object/3DView/Object_mode/Shortcuts/Duplicate}}</nowiki></code> in the clipboard, so that we can mention that button in the wikitext

=== Blender ===

==== Usage ====

Reference information is served in blender itself using '''Helpers'''.

''Examples''

* Helper to communicate how to scroll a header
* Helper to communicate how to split an area.

== Reference versioning (tbd) ==

Reference would be versioned per series (so 2.6, not 2.62), and each series would show the '''current release''':
* when releasing Blender 2.63, the Reference "2.6" would be overwritten by the Reference "2.62"
* when releasing Blender 2.70, the Reference "2.69" would stay and a new Reference "2.7" would start

← 古い版	2018年6月28日 (木) 19:47時点における版
(相違点なし)

利用者:Mindrones/Wiki/Proposals/2012/Reference - 版の履歴

Yamyam: 1版 をインポートしました

wiki>Mont29: /* Automatic information */

Yamyam: 1版をインポートしました