Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# RNA WIKI REFERENCE
#
# This file maps RNA to online URL's for right mouse context menu documentation access
#
# To make international, we made a script,
# pointing the manuals to the proper language,
# specified in the 'User Preferences Window' by the users
# Some Languages have their manual page, using a prefix or
# being preceeded by their respective reference, for example
#
# Doc:2.6 --> Doc:FR/2.6
#
# The table in the script, contains all of the languages we have in the
# Blender wiki website, for those other languages that still
# doesn't have a team of translators, and/or don't have a manual for their languages
# we commented the lines below, you should add them to the language table
# when they have a proper manual in our Blender wiki, or added
# to the Blender UI translation table
# The Blender wiki manual uses a list of ISO_639-1 codes to convert languages to wiki manual prefixes
#
# "DANISH": "DK", - Present in the wiki manual, but not present in Blender UI translations table
# "FARSI": "FA", - Present in the wiki manual, but not present in Blender UI translations table
# "KOREAN": "KO", - Present in the wiki manual, but not present in Blender UI translations table
# "LITHUANIAN": "LT", - Present in the wiki manual, but not present in Blender UI translations table
# "MACEDONIAN": "MK", - Present in the wiki manual, but not present in Blender UI translations table
# "MONGOLIAN": "MN", - Present in the wiki manual, but not present in Blender UI translations table
# "ROMANIAN": "RO", - Present in the wiki manual, but not present in Blender UI translations table
#
# "ESTONIAN": "ET", - Present in the wiki, as an empty page, not present in UI translations table
#
# "CROATIAN": "HR", - Present in Blender UI translations table, but without wiki manual
# "KYRGYZ": "KY", - Present in Blender UI translations table, but without wiki manual
# "NEPALI": "NE", - Present in Blender UI translations table, but without wiki manual
# "PERSIAN": "FA", - Present in Blender UI translations table, but without wiki manual
# "HEBREW": "HE", - Present in Blender UI translations table, but without wiki manual
# "HUNGARIAN": "HU", - Present in Blender UI translations table, but without wiki manual
# "SERBIAN_LATIN": "SR", - Present in Blender UI translations table, but without wiki manual
#
# NOTES:
#
# CHINESE - Present in the wiki as simplified chinese, for both the traditional and simplified
# PORTUGUESE - Present in the wiki for both Portuguese and Brazilian Portuguese
# THAILANDESE - It's the same being used for Turkish in the wiki
#
# URL prefix is the: url_manual_prefix + url_manual_mapping[id]
url_manual_prefix = "http://wiki.blender.org/index.php/Doc:2.6/Manual/"
LANG = {
"ARABIC": "AR",
"BULGARIAN": "BG",
"CATALAN": "CA",
"CZECH": "CZ",
"GERMAN": "DE",
"GREEK": "EL",
"RUSSIAN": "RU",
"SERBIAN": "SR",
"SWEDISH": "SV",
"TURKISH": "TH",
"UKRAINIAN": "UK",
"SPANISH": "ES",
"FINNISH": "FI",
"FRENCH": "FR",
"INDONESIAN": "ID",
"ITALIAN": "IT",
"JAPANESE": "JA",
"DUTCH": "NL",
"POLISH": "PL",
"PORTUGUESE": "PT",
"BRAZILIANPORTUGUESE": "PT",
"SIMPLIFIED_CHINESE": "ZH",
"TRADITIONAL_CHINESE": "ZH",
}.get(__import__("bpy").context.user_preferences.system.language)
url_manual_prefix = url_manual_prefix \
if LANG is None \
else url_manual_prefix.replace("Doc:2.6", "Doc:" + LANG + "/" + "2.6")
# - The first item is a wildcard - typical file system globbing
# using python module 'fnmatch.fnmatch'
# - Expressions are evaluated top down (include catch-all expressions last).
# *** User Prefs ***
("bpy.types.UserPreferences.*", "Preferences"),
("bpy.types.UserPreferencesView.*", "Preferences/Interface"),
("bpy.types.UserPreferencesEdit.*", "Preferences/Editing"),
("bpy.types.UserPreferencesInput.*", "Preferences/Input"),
("bpy.ops.wm.addon_*", "Preferences/Addons"),
("bpy.types.Theme.*", "Preferences/Themes"),
("bpy.types.UserPreferencesFilePaths.*", "Preferences/File"),
("bpy.types.UserPreferencesSystem.*", "Preferences/System"),
("bpy.types.UserSolidLight.*", "Preferences/System"),
("bpy.types.Modifier.show_*", "Modifiers/The_Stack"),
("bpy.types.Modifier.*", "Modifiers"), # catchall for various generic options
("bpy.types.UVProjectModifier.*", "Modifiers/Modify/UV_Project"),
("bpy.types.UVWarpModifier.*", "Modifiers/Modify/UV_Warp"),
("bpy.types.VertexWeightMixModifier.*", "Modifiers/Modify/Vertex_Weight"),
("bpy.types.VertexWeightEditModifier.*", "Modifiers/Modify/Vertex_Weight"),
("bpy.types.VertexWeightProximityModifier.*", "Modifiers/Modify/Vertex_Weight"),
("bpy.types.ArrayModifier.*", "Modifiers/Generate/Array"),
("bpy.types.BevelModifier.*", "Modifiers/Generate/Bevel"),
("bpy.types.BooleanModifier.*", "Modifiers/Generate/Booleans"),
("bpy.types.BuildModifier.*", "Modifiers/Generate/Build"),
("bpy.types.DecimateModifier.*", "Modifiers/Generate/Decimate"),
("bpy.types.EdgeSplitModifier.*", "Modifiers/Generate/Edge_Split"),
("bpy.types.MaskModifier.*", "Modifiers/Generate/Mask"),
("bpy.types.MirrorModifier.*", "Modifiers/Generate/Mirror"),
("bpy.types.MultiresModifier.*", "Modifiers/Generate/Multiresolution"),
("bpy.types.ScrewModifier.*", "Modifiers/Generate/Screw"),
("bpy.types.SkinModifier.*", "Modifiers/Generate/Skin"),
("bpy.types.SolidifyModifier.*", "Modifiers/Generate/Solidify"),
("bpy.types.SubsurfModifier.*", "Modifiers/Generate/Subsurf"),
("bpy.types.ArmatureModifier.*", "Modifiers/Deform/Armature"),
("bpy.types.CastModifier.*", "Modifiers/Deform/Cast"),
("bpy.types.CurveModifier.*", "Modifiers/Deform/Curve"),
("bpy.types.DisplaceModifier.*", "Modifiers/Deform/Displace"),
("bpy.types.DynamicPaintModifier.*", "Physics/Dynamic_Paint"),
("bpy.types.HookModifier.*", "Modifiers/Deform/Hooks"),
("bpy.types.LaplacianSmoothModifier.*", "Modifiers/Deform/Laplacian_Smooth"),
("bpy.types.LatticeModifier.*", "Modifiers/Deform/Lattice"),
("bpy.types.MeshCacheModifier.*", "Modifiers/Deform/Mesh_Cache"),
("bpy.types.MeshDeformModifier.*", "Modifiers/Deform/Mesh_Deform"),
("bpy.types.RemeshModifier.*", "Modifiers/Deform/"),
("bpy.types.ShrinkwrapModifier.*", "Modifiers/Deform/Shrinkwrap"),
("bpy.types.SimpleDeformModifier.*", "Modifiers/Deform/Simple_Deform"),
("bpy.types.SmoothModifier.*", "Modifiers/Deform/Smooth"),
# ("bpy.types.SurfaceModifier.*", "Modifiers/Deform/"), # USERS NEVER SEE THIS
("bpy.types.WarpModifier.*", "Modifiers/Deform/Warp"),
("bpy.types.WaveModifier.*", "Modifiers/Deform/Wave"),
("bpy.types.ClothModifier.*", "Physics/Cloth"),
("bpy.types.CollisionModifier.*", "Physics/Collision"),
("bpy.types.ExplodeModifier.*", "Modifiers/Simulate/Explode"),
("bpy.types.FluidSimulationModifier.*", "Physics/Fluid"),
("bpy.types.OceanModifier.*", "Modifiers/Simulate/Ocean"),
("bpy.types.ParticleInstanceModifier.*", "Modifiers/Simulate/Particle_Instance"),
("bpy.types.ParticleSystemModifier.*", "Physics/Particles"),
("bpy.types.SmokeModifier.*", "Physics/Smoke"),
("bpy.types.SoftBodyModifier.*", "Physics/Soft_Body"),
("bpy.types.Constraint.*", "Constraints"),
("bpy.types.Constraint.mute", "Constraints/The_Stack"), # others could be added here?
("bpy.types.CopyLocationConstraint.*", "Constraints/Transform/Copy_Location"),
("bpy.types.CopyRotationConstraint.*", "Constraints/Transform/Copy_Rotation"),
("bpy.types.CopyScaleConstraint.*", "Constraints/Transform/Copy_Scale"),
("bpy.types.CopyTransformsConstraint.*", "Constraints/Transform/Copy_Transforms"),
("bpy.types.LimitDistanceConstraint.*", "Constraints/Transform/Limit_Distance"),
("bpy.types.LimitLocationConstraint.*", "Constraints/Transform/Limit_Location"),
("bpy.types.LimitRotationConstraint.*", "Constraints/Transform/Limit_Rotation"),
("bpy.types.LimitScaleConstraint.*", "Constraints/Transform/Limit_Scale"),
("bpy.types.MaintainVolumeConstraint.*", "Constraints/Transform/Maintain_Volume"),
("bpy.types.TransformConstraint.*", "Constraints/Transform/Transformation"),
("bpy.types.ClampToConstraint.*", "Constraints/Tracking/Clamp_To"),
("bpy.types.DampedTrackConstraint.*", "Constraints/Tracking/Damped_Track"),
("bpy.types.KinematicConstraint.*", "Constraints/Tracking/IK_Solver"),
("bpy.types.LockedTrackConstraint.*", "Constraints/Tracking/Locked_Track"),
("bpy.types.SplineIKConstraint.*", "Constraints/Tracking/Spline_IK"),
("bpy.types.StretchToConstraint.*", "Constraints/Tracking/Stretch_To"),
("bpy.types.TrackToConstraint.*", "Constraints/Tracking/Track_To"),
("bpy.types.ActionConstraint.*", "Constraints/Relationship/Action"),
("bpy.types.CameraSolverConstraint.*", "Motion_Tracking"), # not exact match
("bpy.types.ChildOfConstraint.*", "Constraints/Relationship/Action"),
("bpy.types.FloorConstraint.*", "Constraints/Relationship/Child_Of"),
("bpy.types.FollowPathConstraint.*", "Constraints/Relationship/Floor"),
("bpy.types.FollowTrackConstraint.*", "Constraints/Relationship/Follow_Path"),
("bpy.types.ObjectSolverConstraint.*", "Motion_Tracking"), # not exact match
("bpy.types.PivotConstraint.*", "Constraints/Relationship/Pivot"),
("bpy.types.PythonConstraint.*", "Constraints/Relationship/Script"),
("bpy.types.RigidBodyJointConstraint.*", "Constraints/Relationship/Rigid_Body_Joint"),
("bpy.types.ShrinkwrapConstraint.*", "Constraints/Relationship/Shrinkwrap"),
("bpy.types.ImageFormatSettings.*", "Render/Output#File_Type"),
("bpy.types.RenderSettings.filepath", "Render/Output#File_Locations"),
Pablo Vazquez
committed
("bpy.types.RenderSettings.display_mode", "Render/Display#Displaying_Renders"),
("bpy.types.RenderSettings.*", "Render"), # catchall, TODO - refine
# *** ID Subclasses ***
("bpy.types.Action.*", "Animation/Actions"),
#("bpy.types.Brush.*", ""), # TODO - manual has no place for this! XXX
("bpy.types.Curve.*", "Modeling/Curves"),
Campbell Barton
committed
("bpy.types.GreasePencil.*", "3D_interaction/Sketching/Drawing"),
("bpy.types.Group.*", "Modeling/Objects/Groups_and_Parenting#Grouping_objects"),
("bpy.types.Image.*", "Textures/Types/Image"),
("bpy.types.ShapeKey.*", "Animation/Basic/Deformation/Shape_Keys"), # not an ID but include because of Key
("bpy.types.Key.*", "Animation/Basic/Deformation/Shape_Keys"),
#("bpy.types.Lattice.*", ""), # TODO - manual has no place for this! XXX
("bpy.types.Library.*", "Manual/Data_System/Linked_Libraries"),
#("bpy.types.Mask.*", ""), # TODO - manual has no place for this! XXX
# *** Materials (blender internal) ***
("bpy.types.Material.diffuse*", "Materials/Properties/Diffuse_Shaders"),
Pablo Vazquez
committed
("bpy.types.Material.specular*", "Materials/Properties/Specular_Shaders"),
("bpy.types.Material.ambient*", "Materials/Properties/Ambient_Light_Effect"),
("bpy.types.Material.preview_render_type", "Materials/Preview"),
("bpy.types.Material.*", "Materials"), # catchall, until the section is filled in
Pablo Vazquez
committed
("bpy.types.MaterialSlot.link", "Materials/Options#Material_naming_and_linking"),
("bpy.types.MaterialVolume.*", "Materials/Properties/Volume"),
("bpy.types.MaterialHalo.*", "Materials/Halos"),
("bpy.types.MaterialStrand.*", "Materials/Properties/Strands"),
("bpy.types.MaterialSubsurfaceScattering.*", "Materials/Properties/Subsurface_Scattering"),
("bpy.types.MaterialRaytraceMirror.*", "Materials/Properties/Raytraced_Reflections"),
("bpy.types.MaterialRaytraceTransparency.*", "Materials/Properties/Raytraced_Transparency#Raytraced_Transparency"),
# ... todo, many more options
("bpy.types.MovieClip.*", "Motion_Tracking#Movie_Clip_Editor"),
#("bpy.types.NodeTree.*", ""), # dont document
("bpy.types.Object.*", "Modeling/Objects"), # catchall, TODO - refine
("bpy.types.ParticleSettings.*", "Physics/Particles"),
("bpy.types.Scene.*", "Interface/Scenes"),
("bpy.types.Screen.*", "Interface/Screens"),
#("bpy.types.Sound.*", ""), # TODO - manual has no place for this! XXX
#("bpy.types.Speaker.*", ""), # TODO - manual has no place for this! XXX
("bpy.types.Text.*", "Extensions/Python/Text_editor"),
("bpy.types.Texture.*", "Textures"),
("bpy.types.VectorFont.*", "Modeling/Texts"),
("bpy.types.WindowManager.*", "Interface/Window_system"),
("bpy.types.World.*", "World"),
# *** ID Subclasses (cont.) Object Data ***
("bpy.types.Mesh.*", "Modeling/Meshes"), # catchall, TODO - refine
("bpy.types.MetaBall.*", "Modeling/Metas"), # catchall, TODO - refine
("bpy.types.TextCurve.*", "Modeling/Texts"), # catchall, TODO - refine
("bpy.types.Armature.*", "Rigging/Armatures"), # catchall, TODO - refine
("bpy.types.Camera.*", "Render/Camera"), # catchall, TODO - refine
("bpy.types.PointLamp.*", "Lighting/Lamps/Lamp"), # catchall, TODO - refine
("bpy.types.AreaLamp.*", "Lighting/Lamps/Area"), # catchall, TODO - refine
("bpy.types.SpotLamp.*", "Lighting/Lamps/Spot"), # catchall, TODO - refine
("bpy.types.SunLamp.*", "Lighting/Lamps/Sun"), # catchall, TODO - refine
("bpy.types.HemiLamp.*", "Lighting/Lamps/Hemi"), # catchall, TODO - refine
("bpy.types.Lamp.*", "Lighting"), # catchall, TODO - refine
# --- Animation ---
("bpy.types.Keyframe.*", "Animation/Keyframes"),
Campbell Barton
committed
("bpy.types.FCurve.*", "Animation/Editors/Graph/FCurves"),
# --- Rigging ---
("bpy.types.Bone.*", "Armatures/Bones"),
("bpy.types.EditBone.*", "Armatures/Bones"),
("bpy.types.PoseBone.*", "Rigging/Posing"),
# --- World ---
("bpy.types.World.*", "World"),
("bpy.types.Texture.*", "Textures"),
# *** Spaces ***
("bpy.types.SpaceView3D.*", "3D_interaction/Navigating/3D_View_Options"),
Campbell Barton
committed
# Catch all only for now!
Campbell Barton
committed
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
("bpy.ops.action.*", "Animation/Actions"),
("bpy.ops.anim.*", "Animation"),
("bpy.ops.armature.*", "Rigging/Armatures"),
("bpy.ops.boid.*", "Physics/Particles/Physics/Boids"),
# ("bpy.ops.brush.*", ""), # TODO
("bpy.ops.buttons.*", "Interface/Buttons_and_Controls"),
("bpy.ops.camera.*", "Render/Camera"),
("bpy.ops.clip.*", "Motion_Tracking#Movie_Clip_Editor"),
("bpy.ops.cloth.*", "Physics/Cloth"),
("bpy.ops.console.*", "Python/Console"),
("bpy.ops.constraint.*", "Constraints"),
("bpy.ops.curve.*", "Modeling/Curves"),
("bpy.ops.dpaint.*", "Physics/Dynamic_Paint"),
# ("bpy.ops.ed.*", ""), # TODO, this is for internal use only?
# ("bpy.ops.export_anim.*", ""), # TODO
# ("bpy.ops.export_mesh.*", ""), # TODO
# ("bpy.ops.export_scene.*", ""), # TODO
("bpy.ops.file.*", ""),
("bpy.ops.fluid.*", "Physics/Fluid"),
("bpy.ops.font.*", "Modeling/Texts"),
("bpy.ops.gpencil.*", "3D_interaction/Sketching/Drawing"),
("bpy.ops.graph.*", "Animation/Editors/Graph/FCurves"),
("bpy.ops.group.*", "Modeling/Objects/Groups_and_Parenting#Grouping_objects"),
("bpy.ops.image.*", "Textures/Types/Image"),
# ("bpy.ops.import_anim.*", ""), # TODO
# ("bpy.ops.import_curve.*", ""), # TODO
# ("bpy.ops.import_mesh.*", ""), # TODO
# ("bpy.ops.import_scene.*", ""), # TODO
# ("bpy.ops.info.*", ""), # TODO
Campbell Barton
committed
("bpy.ops.lamp.*", "Lighting"), # --- TODO ... all below ---
# ("bpy.ops.lattice.*", ""), # TODO
("bpy.ops.logic.*", "Game_Engine/Logic"),
("bpy.ops.marker.*", "Animation/Markers"),
# ("bpy.ops.mask.*", ""), # TODO
Pablo Vazquez
committed
("bpy.ops.material.new", "Materials/Assigning_a_material#Creating_a_new_Material"),
("bpy.ops.material.*", "Materials"),
("bpy.ops.mball.*", "Modeling/Metas"),
("bpy.ops.mesh.*", "Modeling/Meshes"),
("bpy.ops.nla.*", "Animation/Editors/NLA"),
# ("bpy.ops.node.*", ""), # TODO
("bpy.ops.object.*", "Modeling/Objects"),
("bpy.ops.outliner.*", "Data_System/The_Outliner"),
# ("bpy.ops.paint.*", ""), # TODO
("bpy.ops.particle.*", "Physics/Particles"),
("bpy.ops.pose.*", "Rigging/Posing"),
("bpy.ops.poselib.*", "Rigging/Posing/Pose_Library"),
# ("bpy.ops.ptcache.*", ""), # TODO
("bpy.ops.render.play_rendered_anim", "Render/Display#Animation_Playback"),
("bpy.ops.render.*", "Render"), # catchall
("bpy.ops.scene.*", "Interface/Scenes"),
("bpy.ops.screen.*", "Interface/Window_system"),
("bpy.ops.script.*", "Extensions/Python"),
("bpy.ops.sculpt.*", "Modeling/Meshes/Editing/Sculpt_Mode"),
("bpy.ops.sequencer.*", "Sequencer/Usage"),
# ("bpy.ops.sketch.*", ""), # TODO
# ("bpy.ops.sound.*", ""), # TODO
("bpy.ops.surface.*", "Modeling/Surfaces"),
("bpy.ops.text.*", "Extensions/Python/Text_editor"),
("bpy.ops.texture.*", "Textures"),
("bpy.ops.time.*", "Animation/Timeline"),
("bpy.ops.transform.*", "3D_interaction/Transform_Control"),
("bpy.ops.ui.*", "Interface"),
("bpy.ops.uv.*", "Textures/Mapping/UV/Layout_Editing"),
# ("bpy.ops.view2d.*", ""), # TODO
("bpy.ops.view3d.*", "3D_interaction/Navigating/3D_View"), # this link is a bit arbitrary
("bpy.ops.wm.*", "Interface/Window_system"),
("bpy.ops.world.*", "World"),
# may have 'url_reference_mapping'... etc later