Hi!
Perl Oasis is a new Win32::GUI application I created. It's in beta
currently, but feel free to download and spread the word. I'm very
interested in comments and bug reports. The Perl license applies.
** Introduction
Perl Oasis is a source/POD/class browser tightly integrated with
(currently) UltraEdit. It makes it easy to navigate source code, POD and
modules.
* Download
http://www.bahnhof.se/~johanl/perl/Oasis/
Oasis_source.zip contains the entire source tree.
Oasis_binary.zip is the end-user distribution, a freestanding GUI PerlApp
application. You'll need Perl (probably 5.6) installed, but no other modules.
* Getting started
Start UltraEdit (it works without UltraEdit but not nearly as smoothly).
Start Perl Oasis.
Always, the file you currently have open in UltraEdit should appear in the
topmost text field in Oasis. Click the "Load" button to bring the file into
Oasis. You can also "Copy" a file in the Explorer, move to Oasis and
"Paste" it into the text field (useful if you don't have UltraEdit).
The file is parsed and the contents is displayed. Explore! Try opening a
few of your own files, the Oasis source files and modules on your system.
Oasis does not change any source files.
The "=> Editor" button will open up the file in UltraEdit at the correct
location.
The "=> Module" button will the selected module into Oasis.
** Features
The source is parsed in a simplistic way to extract meta-information which
is displayed in the tree to the left. Select a node in the tree to display
the corresponding text in the right pane. Double click to go to the editor.
* POD
The POD is parsed using POD::Parse. =head1 and =head2 items are displayed
in the tree. Both the POD tab and the source tab is updated when you select
a node.
* Subroutines
Subroutines are defined as lines that start with "sub something".
* Used modules
"Used modules" are defined as lines that start with "use something". Double
click to load that module. Oasis will find the file if it's in a project of
yours or in an @INC directory.
* Bookmarks
A Bookmark is a custom pattern used to identify certain parts of the code.
You can define your own by editing the config file resource/pde.xml.
Example: the bookmark "Todo" is defined as lines that contain "##todo"
(load the file lib/PDE/App.pm to see an example of this).
I'd appreciate suggestions for useful default Bookmark patterns.
* Supported Editors
Currently only UltraEdit is supported because... well... that's what I use.
If you need support for another editor, please e-mail me
(mailto:[EMAIL PROTECTED]).
** Configuration
Edit the config file resource/pde.xml. Be careful. Keep a backup copy. The
most useful thing you can configure is which features should be parsed and
displayed (that's doPOD, doSub etc.)
The config should eventually be managed through Edit | Preferences...
Like I said, it's a beta so comments, bug reports and feature requests are
on the top of my wish list :)
/J
--
Johan Lindström, Sourcerer, Boss Casinos Ltd, Antigua
[EMAIL PROTECTED]
