Changes between Initial Version and Version 1 of DeveloperOverview


Ignore:
Timestamp:
May 9, 2009 10:18:21 AM (9 years ago)
Author:
chriz
Comment:

Migrated from old trac wiki

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperOverview

    v1 v1  
     1= Developer Overview =
     2== Layout ==
     3 * lib - The core wikidPad source code.
     4 * docs - wikidPad documentation
     5 * export - Resources used when exporting.
     6 * extensions - Default implementations of the extension classes.
     7 * gadfly-1.0.0 - Gadfly distribution. We actually use the gadfly instance under lib/gadfly.
     8 * icons - wikidPad icons.
     9 * installer - The NSIS installer script lives here.
     10 * tobuild - Required software for wikidPad dev.
     11 * WikidPadHelp - Help wiki distributed with wikidPad.
     12 * build.bat - Builds a wikidPad exe using py2exe.
     13 * setup.py - The py2exe script.
     14The sql_mar files in the root are the gadfly grammar, and compiled grammar. The included
     15gadfly has been modified to use these since py2exe doesn't seem to support adding the
     16pyc to the exe. The sql_mar files are copied into the dist.
     17
     18{{{
     19sql_mar.pyc
     20sql_mar.pyo
     21}}}
     22
     23== Source Overview ==
     24
     25 * WikidPad.py (in root): Essentially the "main" method for PersonalWikiFrame.py.
     26 * PersonalWikiFrame.py: This is the meat of wikidPad. Start here.
     27 * WikiData.py: 2nd most important class. All data access is mediated through this class.
     28 * WikiTxtCtrl.py: This is the code dealing with Scintilla.
     29 * WikiTreeCtrl.py: Tree control code.
     30 * WikiFormatting.py: Container for regex's, and styles.
     31 * Exporters.py: html/xml export code.
     32 * TextWrapper.py: I snagged this from somewhere. This runs when you press Ctrl-W.
     33 * Enum.py: Also snagged from somewhere, python enums.
     34 * Config.py: Default fonts. I think I meant to do more with this file. Actually, I think it did do some registration stuff before.
     35
     36== API ==
     37
     38See WikidPadApi
     39