From f8c364fc69397752c3a78b7ac18b142b2dbf1b83 Mon Sep 17 00:00:00 2001 From: James Teh Date: Wed, 23 Feb 2011 10:57:25 +1000 Subject: [PATCH] Rename pluginGuide to developerGuide, as it will eventually contain information about topics other than plugins. Add an Introduction and move the section about Python there. --- pluginGuide.t2t => developerGuide.t2t | 17 +++++++++++------ sconstruct | 4 ++-- 2 files changed, 13 insertions(+), 8 deletions(-) rename pluginGuide.t2t => developerGuide.t2t (96%) diff --git a/pluginGuide.t2t b/developerGuide.t2t similarity index 96% rename from pluginGuide.t2t rename to developerGuide.t2t index dfc6d2253..4749ecf06 100644 --- a/pluginGuide.t2t +++ b/developerGuide.t2t @@ -1,4 +1,4 @@ -NVDA NVDA_VERSION Plugin Guide +NVDA NVDA_VERSION Developer Guide %!includeconf: user_docs/userGuide.t2tconf @@ -6,6 +6,16 @@ NVDA NVDA_VERSION Plugin Guide = Table of Contents =[toc] %%toc ++ Introduction + +This guide provides information for new developers wishing to developing components for NVDA. +Note that this is only an introduction. +Developers should consult the code documentation for a complete reference. + +++ A Note About Python ++ +NVDA and its components are primarily written in the Python programming language. +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. +Documentation and other resources related to the Python language can be found at www.python.org/ + + Plugins + ++ Overview ++ @@ -17,11 +27,6 @@ They are able to: - Customise or add new support for text content and complex documents. - -++ A Note About Python ++ -Plugins are written in the Python language. -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. -Documentation and other resources related to the Python language can be found at www.python.org/ - ++ Types of Plugins ++ There are two types of plugins. These are: - App Modules: code specific to a particular application. diff --git a/sconstruct b/sconstruct index 69982fd72..2e0c05def 100755 --- a/sconstruct +++ b/sconstruct @@ -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 htmlFile=env.txt2tags(t2tFile) env.SideEffect('_txt2tags',htmlFile) -#And also build the plugin guide -- which must be moved at some point -htmlFile=env.txt2tags('pluginGuide.t2t') +#And also build the developer guide -- which must be moved at some point +htmlFile=env.txt2tags('developerGuide.t2t') env.SideEffect('_txt2tags',htmlFile) env.Depends(sourceDir,userDocsDir) -- 2.11.0