= Peppy Development Home =

-- (ap)'''P'''roximated (x)'''E'''macs '''P'''owered by '''Py'''thon

This is a [http://www.wxpython.org wxPython]/[http://www.scintilla.org Scintilla]-based editor written in and extensible through [http://www.python.org Python]. It attempts to provide an [http://www.xemacs.org XEmacs]-like multi-window, multi-tabbed interface using the [http://www.kirix.com/labs.html Advanced User Interface] (wx.aui) framework of wxPython.  Extensibility is based on [http://yapsy.sourceforge.net Yapsy] plugins.

This is the home of the development guide for peppy.  All documentation about the architecture and inner workings of peppy in the Python language are here.  If you're interested in the project management artifacts or the user guides, see the [http://www.flipturn.org/peppy peppy homepage].

== User Starting Points ==

 * [http://peppy.flipturn.org/ Peppy homepage] -- Project summary, installation information, and project management documentation
 * [http://peppy.flipturn.org/download.html Downloads] -- Current and past releases available for download
 * [http://peppy.flipturn.org/manual/index.html User's Manual] -- User's guide to peppy
   * ConfigurationFiles -- Description of the peppy configuration file

== Developer Starting Points ==

 * DevelopmentOverview -- Summary of the concepts and terms used in the source code
 * ArchitectureOverview -- High level overview of the architecture of the editor
   * MenuOverview -- A description of the menu system
   * KeyboardProcessing -- Keyboard overview including keybinding specifications
   * IconResources -- How icon resources are specified and used
 * ReindentCodeLog -- A development log of how the reindent code for C-ish modes was (is) developed
 * CodeExplorer -- Description of the Code Explorer minor mode
 * HyperspectralImagery -- Notes about the HSI major mode
 * RegexSearch -- Notes on how the regular expression search was implemented
 * IdeFeatures -- Notes on the development of IDE-like features like autocompletion and debugging
 * [wiki:Macros] -- Notes on the development of macros that record user actions
 * TextMateSnippets -- Notes on the development of [http://macromates.com/ TextMate] snippet support
 * [wiki:i18n] -- Using [https://translations.launchpad.net/peppy LaunchPad] for translations
 * VirtualFileSystem -- Using and extending the [http://www.hforge.org/itools/ itools vfs]
 * ScratchPad -- Ideas to explore in the future

=== Tutorials ===

 * Tutorials about adding new menu items and keyboard commands.  Probably the best place to begin!
   * HelloWorldTutorial -- Walkthrough of the !InsertHelloWorld action showing how to add a simple menu bar and keyboard action
   * SimpleActionTutorial -- Tutorial showing how to create a new action that works with `FundamentalMode` and its subclasses
 * MinorModeTutorial -- Simple example of creating a new minor mode
 * SidebarTutorial -- Adding a simple sidebar
 * MajorModeTutorial -- Adding a new major mode

=== Howtos ===

 * UsingPyParse -- How to use the python parser from IDLE with a Scintilla editing component in Python

=== Deployment ===

 * ApplicationBundles -- Dealing with py2exe and py2app

=== Reference ===

 * [http://peppy.flipturn.org/api/index.html Autogenerated API reference]
 * [http://peppy.flipturn.org/api/peppy.major.MajorMode-class.html Major Mode reference] -- for implementing a new Major Mode

 * PeppyPlugins -- Plugin overview
 * [http://peppy.flipturn.org/api/peppy.yapsy.plugins.IPeppyPlugin-class.html Plugin API]

For a complete list of local wiki pages, see TitleIndex.