OSDN Git Service

Rename pluginGuide to developerGuide, as it will eventually contain information about...
authorJames Teh <jamie@jantrid.net>
Wed, 23 Feb 2011 00:57:25 +0000 (10:57 +1000)
committerJames Teh <jamie@jantrid.net>
Wed, 23 Feb 2011 00:57:25 +0000 (10:57 +1000)
developerGuide.t2t [moved from pluginGuide.t2t with 96% similarity]
sconstruct

similarity index 96%
rename from pluginGuide.t2t
rename to developerGuide.t2t
index dfc6d22..4749ecf 100644 (file)
@@ -1,4 +1,4 @@
-NVDA NVDA_VERSION Plugin Guide\r
+NVDA NVDA_VERSION Developer Guide\r
 \r
 \r
 %!includeconf: user_docs/userGuide.t2tconf\r
@@ -6,6 +6,16 @@ NVDA NVDA_VERSION Plugin Guide
 = Table of Contents =[toc]\r
 %%toc\r
 \r
++ Introduction +\r
+This guide provides information for new developers wishing to developing components for NVDA.\r
+Note that this is only an introduction.\r
+Developers should consult the code documentation for a complete reference.\r
+\r
+++ A Note About Python ++\r
+NVDA and its components are primarily written in the Python programming language.\r
+It is not the goal of this guide to teach you Python, though examples are provided through out this guide which will help to familiarise you with the Python syntax.\r
+Documentation and other resources related to the Python language can be found at www.python.org/\r
+\r
 + Plugins +\r
 \r
 ++ Overview ++\r
@@ -17,11 +27,6 @@ They are able to:
 - Customise or add new support for text content and complex documents.\r
 -\r
 \r
-++ A Note About Python ++\r
-Plugins are written in the Python language.\r
-It is not the goal of this guide to teach you Python, though examples are provided through out this guide which will help to familiarise you with the Python syntax.\r
-Documentation and other resources related to the Python language can be found at www.python.org/\r
-\r
 ++ Types of Plugins ++\r
 There are two types of plugins. These are:\r
 - App Modules: code specific to a particular application.\r
index 69982fd..2e0c05d 100755 (executable)
@@ -125,8 +125,8 @@ for t2tFile in env.Glob(os.path.join(userDocsDir.path,'*','*.t2t')):
        #txt2tags can not be run in parallel so make sure scons knows this\r
        htmlFile=env.txt2tags(t2tFile)\r
        env.SideEffect('_txt2tags',htmlFile)\r
-#And also build the plugin guide -- which must be moved at some point\r
-htmlFile=env.txt2tags('pluginGuide.t2t')\r
+#And also build the developer guide -- which must be moved at some point\r
+htmlFile=env.txt2tags('developerGuide.t2t')\r
 env.SideEffect('_txt2tags',htmlFile)\r
 \r
 env.Depends(sourceDir,userDocsDir)\r