Changeset 1499

Timestamp:

07/21/08 20:33:17 (7 weeks ago)

Author:

rob

Message:

User manual updates

Location:

trunk/manual

Files:

• fundamental.rst (modified) (1 diff)
• preferences.rst (modified) (2 diffs)

trunk/manual/fundamental.rst

@@ -8 +8 @@
 ================
 
+Fundamental mode is the basis for all source code editing modes in peppy.
+All of the text editing functions that are common to more than one mode are
+generally placed in Fundamental mode.  If you're familiar with object oriented
+programming concepts, Fundamental mode is the *superclass* of the other text
+editing modes.
+
+
+Hierarchies of Major Modes
+--------------------------
+
+
+
 
 Scintilla and the Styled Text Control
 -------------------------------------
 
+Peppy uses the wxPython component called the StyledTextCtrl for its user
+interface, which is based on the source code editing component called
+Scintilla__.  Scintilla and the StyledTextCtrl supply the highlighting, syntax
+coloring, code folding, line numbers, word wrapping, and many more built-in
+features.  Additionally, due to the cross-platform nature of both wxPython and
+Scintilla, peppy operates in very similarly across the three major classes of
+operating systems supported by wxPython: unix-like systems, Windows, and Mac
+OS X.
 
-Hierarchies of Major Modes
---------------------------
+__ www.scintilla.org
 
 

trunk/manual/preferences.rst

@@ -10 +10 @@
 through the GUI.  Those settings that can't must be modified by hand in the
 configuration directory.
+
+
+Using the Preferences Dialog
+============================
+
+Most of the common configuration options are available through the preferences
+dialog.  
+
+...Picture of the preferences dialog goes here...
+
+
+
+
+Changing Text Styles
+====================
+
+Font colors and styles are changed using the Edit -> Text Styles dialog.  This
+associates particular syntax elements of the text file with styles and colors
+specified here.  If you're familiar with Editra__, you'll recognize the text
+style dialog:
+
+...Picture of the text style dialog goes here...
+
+Peppy uses the same styling system as Editra, and indeed can use the same style
+sheets as created by Editra when placed in the proper configuration directory
+of peppy.  (See below for more information on configuration files.)
+
+The convenient characteristic of the Editra styling system is syntax elements
+are styled using the same font/color combination regardless of language.  So,
+for example, comments in Python will appear the same as comments in C++.  This
+leads to a much quicker setup time when configuring peppy to display syntax
+elements in the manner that you like.
+
+__ www.editra.org
+
+Changing Fonts
+--------------
+
+The only text styling item not set through the text style dialog is the
+specific font used to display the text.  This is set through the main
+Preferences dialog, in the General tab and the Fonts item.
+
+The wxPython StyledTextCtrl uses a single font for the main text, and can
+optionally use a separate font for the line numbers.  These fonts are set in
+the Preferences dialog: in the General tab, choose the Fonts item and select
+the primary editing font (for the main text) and the secondary editing font
+(for the line numbers).
+
 
 
@@ -43 +91 @@
 You can select from any of the languages in the list, and the user interface
 will change immediately.  No need to restart the application!
-
-
-Changing Text Styles
-====================
-
-The wxPython StyledTextCtrl uses a single font for the main text, and can
-optionally use a separate font for the line numbers.  These fonts are set in
-the Preferences dialog: in the General tab, choose the Fonts item and select
-the primary editing font (for the main text) and the secondary editing font
-(for the line numbers).
-
-Font colors and styles are changed using the Edit -> Text Styles dialog.  This
-associates particular syntax elements of the text file with styles and colors
-specified here.