[tubras] r1908 committed - doc tweaks.
tub...@googlecode.com
Author: pc0...@gmail.com
Date: Mon Jan 16 11:02:27 2012
Log: doc tweaks.
http://code.google.com/p/tubras/source/detail?r=1908
Modified:
/trunk/tools/irrb/doc/_templates/index.html
/trunk/tools/irrb/doc/export_panel.rst
/trunk/tools/irrb/doc/install.rst
/trunk/tools/irrb/doc/interface.rst
=======================================
--- /trunk/tools/irrb/doc/_templates/index.html Sat Jan 14 11:34:59 2012
+++ /trunk/tools/irrb/doc/_templates/index.html Mon Jan 16 11:02:27 2012
@@ -26,7 +26,7 @@
</div>
<p>
<b>irrB</b> [<a href="#" onclick="playSound('_static/irrb.wav');"><img
align="bottom" src="_static/sound.png"></a> urb]
- is a tool that makes it easy to integrate Blender generated content
+ is a tool that makes it easy to integrate content created in Blender
into your <a href="http://irrlicht.sourceforge.net/"
target="_blank">Irrlicht</a> based application. It is <a
href="http://unlicense.org/"
target="_blank">unlicensed</a>
=======================================
--- /trunk/tools/irrb/doc/export_panel.rst Sat Dec 31 11:37:27 2011
+++ /trunk/tools/irrb/doc/export_panel.rst Mon Jan 16 11:02:27 2012
@@ -6,8 +6,9 @@
:maxdepth: 2
The Export panel is designed to control what is exported along with the
location
-of the generated output. If you have installed and configured the
**irrB** utilities,
-you may also choose to optionally walktest your exported scene.
+of the generated output. If you have installed and configured a walk test
+application (see :doc:`irrB Utilities </utilities>`), you may also choose
to
+optionally walk test your exported scene.
.. Note::
All output (texture, mesh, & scene files) generated by **irrB** will be
written
@@ -15,10 +16,10 @@
By default:
* The **Scene** file (.irr) is saved to the output directory -
- "{out}/{scene name}.irr".
- * **Texture** files are written to a sub-directory named "tex"
- "{out}/tex/".
+ "{Out Directory}/{scene name}.irr".
+ * **Texture** files are written to a sub-directory named "tex" - "{Out
Directory}/tex/".
* **Mesh** files are written to a sub-directory named "mdl" -
- "{out}/mdl/".
+ "{Out Directory}/mdl/".
All file references in the generated scene and mesh files are relative
as well.
This allows scenes to be loaded from arbitrary locations as long as the
base
@@ -50,10 +51,10 @@
If checked, an Irrlicht scene file is written to the selected output
directory. The
generated scene file name is based on the active Blender scene name:
- "{out}/{Blender scene name}.irr"
+ "{Out Directory}/{Blender scene name}.irr"
Therefore, if the scene being exported is named "TestLevel", the generated
scene file
-would be saved to "{out}/TestLevel.irr".
+would be saved to "{Out Directory}/TestLevel.irr".
**Light(s)** - Check box used to indicate whether or not light objects are
written
to the Irrlicht scene file.
@@ -72,12 +73,12 @@
will appear.
**Pack Files** - Check box used to indicate whether or not **all**
generated
-output will be packed into a single "{scene name}.zip" file.
+output will be packed into a single "{Out Directory}/{scene name}.zip"
file.
**Make Executable** - Check box used to indicate whether or not to
create an executable containing all of the scene, mesh, and texture
data embedded in the generated executable. The generated executable file
name is based
-on the current Blender scene name - "{scene name}.exe". Note that this
+on the current Blender scene name - "{Out Directory}/{scene name}.exe".
Note that this
option will only appear if the iwalktest utility has been installed and
properly configured.
=======================================
--- /trunk/tools/irrb/doc/install.rst Sat Jan 14 11:34:59 2012
+++ /trunk/tools/irrb/doc/install.rst Mon Jan 16 11:02:27 2012
@@ -15,25 +15,28 @@
.. image:: _static/img001.png
-The contents of the zip package are:
+The contents of the zip package include:
* io_export_irrlicht.py
* docs/{html documentation files}
To install **irrB**, unzip the contents of the zip file into a temporary
directory
-and install it as a Blender **addon**.
+and install it as a Blender **addon**:
1. Start Blender and call up the **User Preferences** dialog (File | User
Preferences..).
+
2. Click on the **Addons** tab and then the **Install Addon...** button
located at
the bottom of the dialog.
+
3. Navigate to the directory where you previously unzipped the **irrB**
zip file into, select
- the file **io_export_irrlicht.py**, and then click the **Install
Addon...** button.
+ the file **io_export_irrlicht.py**, and then click the **Install
Addon...** button.
+
4. Locate the **irrB** exporter in the **Import-Export** section and
enable it by selecting
the corresponding check box.
If you would like **irrB** to be automatically activated every time you
start Blender,
then click the **Save As Default** button located at the bottom of the
dialog.
-If you don't click **Save As Default**, you will to need activate the
**irrB** add-on
+If you don't click **Save As Default**, you will need to activate the
**irrB** add-on
each time you start up Blender.
Documentation on installing and configuring "iwalktest" for both Windows
and Linux
=======================================
--- /trunk/tools/irrb/doc/interface.rst Sun Dec 11 16:19:48 2011
+++ /trunk/tools/irrb/doc/interface.rst Mon Jan 16 11:02:27 2012
@@ -20,20 +20,20 @@
:doc:`Export Panel </export_panel>`
-The **export** property panel is located in the Blender's **Scene**
properties panel group.
+The **export** property panel is located in Blender's **Scene** properties
panel group.
This panel allows you to set export specific options and choose whether or
not to walktest
your scene after exporting.
:doc:`Object Panel </object_panel>`
-The **object** property panel is located in the Blender's **Object**
properties panel group.
+The **object** property panel is located in Blender's **Object**
properties panel group.
This panel allows you to set an object's scene node ID, the object type,
and type
dependent properties.
:doc:`Material Panel </material_panel>`
The **material** property panel is located in Blender's **Material**
properties panel group.
-This panel allows you to set every Irrlicht `SMaterial
<http://irrlicht.sourceforge.net/docu/classirr_1_1video_1_1_s_material.html>`_
property from within
+This panel allows you to set every Irrlicht `SMaterial
<http://irrlicht.sourceforge.net/docu/classirr_1_1video_1_1_s_material.html>`_
property within
Blender.