[de6804]: readme.html Maximize Restore History

Download this file

readme.html    892 lines (874 with data), 56.2 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.7: http://docutils.sourceforge.net/" />
<title>Readme/Help for PyPE (Python Programmer's Editor)</title>
<link rel="stylesheet" href="default.css" type="text/css" />
</head>
<body>
<div class="document" id="readme-help-for-pype-python-programmer-s-editor">
<h1 class="title">Readme/Help for PyPE (Python Programmer's Editor)</h1>
<style type="text/css">
pre.literal-block {
    background-color: rgb(192, 192, 255);
    margin: 0cm 1.5cm 0cm 1.5cm;
}
</style><div class="contents topic" id="table-of-contents">
<p class="topic-title first"><a name="table-of-contents">Table of Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#license-and-contact-information" id="id4" name="id4">License and Contact information</a></li>
<li><a class="reference" href="#requirements" id="id5" name="id5">Requirements</a></li>
<li><a class="reference" href="#installation" id="id6" name="id6">Installation</a><ul>
<li><a class="reference" href="#why-doesn-t-the-windows-install-work" id="id7" name="id7">Why doesn't the Windows install work?</a></li>
<li><a class="reference" href="#why-doesn-t-pype-work-on-linux" id="id8" name="id8">Why doesn't PyPE work on Linux?</a></li>
<li><a class="reference" href="#why-isn-t-the-most-recent-pype-available-as-deb-or-rpm" id="id9" name="id9">Why isn't the most recent PyPE available as deb or RPM?</a></li>
<li><a class="reference" href="#why-doesn-t-pype-work-on-osx" id="id10" name="id10">Why doesn't PyPE work on OSX?</a></li>
</ul>
</li>
<li><a class="reference" href="#command-line-options" id="id11" name="id11">Command Line Options</a><ul>
<li><a class="reference" href="#last" id="id12" name="id12">--last</a></li>
<li><a class="reference" href="#unicode-and-ansi" id="id13" name="id13">--unicode and --ansi</a></li>
<li><a class="reference" href="#nothread" id="id14" name="id14">--nothread</a></li>
<li><a class="reference" href="#macros" id="id15" name="id15">--macros</a></li>
</ul>
</li>
<li><a class="reference" href="#pype-features-and-functionality" id="id16" name="id16">PyPE features and functionality</a><ul>
<li><a class="reference" href="#what-is-sloppy-cut-copy" id="id17" name="id17">What is Sloppy Cut/Copy?</a></li>
<li><a class="reference" href="#what-is-smart-paste" id="id18" name="id18">What is Smart Paste?</a></li>
<li><a class="reference" href="#what-do-the-different-options-in-the-filter-tool-do" id="id19" name="id19">What do the different options in the Filter tool do?</a></li>
<li><a class="reference" href="#dictionaries-and-alphabets-for-the-spell-checker" id="id20" name="id20">Dictionaries and alphabets for the Spell checker</a></li>
<li><a class="reference" href="#how-does-one-pype-work" id="id21" name="id21">How does &quot;One PyPE&quot; work?</a></li>
<li><a class="reference" href="#what-the-heck-is-a-trigger" id="id22" name="id22">What the heck is a Trigger?</a></li>
<li><a class="reference" href="#find-replace-bars" id="id23" name="id23">Find/Replace bars</a></li>
<li><a class="reference" href="#string-escapes-in-regular-expressions-and-multiline-searches" id="id24" name="id24">String escapes in regular expressions and multiline searches?</a></li>
<li><a class="reference" href="#what-happens-when-smart-case-is-enabled-during-a-replace" id="id25" name="id25">What happens when &quot;Smart Case&quot; is enabled during a replace?</a></li>
<li><a class="reference" href="#what-is-up-with-the-enable-file-drops-checkbox-in-the-edit-menu" id="id26" name="id26">What is up with the &quot;Enable File Drops&quot; checkbox in the 'Edit' menu?</a></li>
<li><a class="reference" href="#how-do-i-use-the-todo-list" id="id27" name="id27">How do I use the 'Todo' list?</a></li>
<li><a class="reference" href="#what-are-the-known-issues-within-pype-s-parser" id="id28" name="id28">What are the known issues within PyPE's parser?</a><ul>
<li><a class="reference" href="#the-c-c-parser" id="id29" name="id29">The C/C++ parser</a></li>
<li><a class="reference" href="#the-python-parser" id="id30" name="id30">The Python parser</a></li>
</ul>
</li>
<li><a class="reference" href="#how-do-you-get-usable-calltips" id="id31" name="id31">How do you get usable Calltips?</a></li>
<li><a class="reference" href="#how-do-you-get-autocompletion" id="id32" name="id32">How do you get autocompletion?</a></li>
<li><a class="reference" href="#crlf-lf-cr-line-endings" id="id33" name="id33">CRLF/LF/CR line endings</a></li>
<li><a class="reference" href="#stcstyleeditor-py" id="id34" name="id34">STCStyleEditor.py</a></li>
<li><a class="reference" href="#expandable-collapsable-foldable-code" id="id35" name="id35">Expandable/collapsable/foldable code</a></li>
<li><a class="reference" href="#converting-between-tabs-and-spaces" id="id36" name="id36">Converting between tabs and spaces</a></li>
</ul>
</li>
<li><a class="reference" href="#how-do-i-program-my-own-macros" id="id37" name="id37">How do I program my own macros?</a><ul>
<li><a class="reference" href="#an-example-nontrivial-macro" id="id38" name="id38">An example nontrivial macro</a></li>
<li><a class="reference" href="#using-macros-as-code-snippets" id="id39" name="id39">Using macros as code snippets</a></li>
</ul>
</li>
<li><a class="reference" href="#faq" id="id40" name="id40">FAQ</a><ul>
<li><a class="reference" href="#how-do-you-come-up-with-new-feature-ideas" id="id41" name="id41">How do you come up with new feature ideas?</a></li>
<li><a class="reference" href="#what-s-the-deal-with-the-version-numbering-scheme" id="id42" name="id42">What's the deal with the version numbering scheme?</a></li>
<li><a class="reference" href="#how-did-pype-come-about" id="id43" name="id43">How did PyPE come about?</a></li>
</ul>
</li>
<li><a class="reference" href="#thank-yous" id="id44" name="id44">Thank Yous</a></li>
</ul>
</div>
<div class="section" id="license-and-contact-information">
<h1><a class="toc-backref" href="#id4" name="license-and-contact-information">License and Contact information</a></h1>
<p><a class="reference" href="http://pype.sourceforge.net">http://pype.sourceforge.net</a>
<a class="reference" href="http://come.to/josiah">http://come.to/josiah</a></p>
<p>PyPE is copyright 2003-2006 Josiah Carlson.
Contributions are copyright their respective authors.</p>
<p>This software is licensed under the GPL (GNU General Public License) version 2
as it appears here: <a class="reference" href="http://www.gnu.org/copyleft/gpl.html">http://www.gnu.org/copyleft/gpl.html</a>
It is also included with this archive as <a class="reference" href="gpl.txt">gpl.txt</a>.</p>
<p>The included STCStyleEditor.py, which is used to support styles, was released
under the wxWindows license and is copyright (c) 2001 - 2002 Riaan Booysen.
The copy included was also distributed with the wxPython Demos and Docs for
wxPython version 2.6 for Python 2.3, and may or may not have been modified by
the time you read this.  The wxWindows license and the LGPL license it
references are included with this software as <a class="reference" href="wxwindows.txt">wxwindows.txt</a>
and <a class="reference" href="lgpl.txt">lgpl.txt</a>.</p>
<p>The included stc-styles.rc.cfg was modified from the original version in order
to not cause exceptions during style changes, as well as adding other language
style definitions, and was originally distributed with wxPython version
2.4.1.2 for Python 2.2 .</p>
<p>If you do not also receive a copy of <a class="reference" href="gpl.txt">gpl.txt</a>,
<a class="reference" href="wxwindows.txt">wxwindows.txt</a>, and <a class="reference" href="lgpl.txt">lgpl.txt</a> with your version
of this software, please inform me of the violation at either web page at the
top of this document.</p>
</div>
<div class="section" id="requirements">
<h1><a class="toc-backref" href="#id5" name="requirements">Requirements</a></h1>
<p>Either a machine running Python and wxPython, or a Windows machine that can
run the binaries should be sufficient.  Initial revisions of PyPE were
developed on a PII-400 with 384 megs of ram, but it should work on any machine
that can run the most recent wxPython revisions.  Some portions may be slow
(Document-&gt;Wrap Long Lines especially, which is a known issue with the
scintilla text editor control), but it should still be usable.</p>
<p>PyPE 2.x has only been tested on Python 2.3 and wxPython 2.6.3.0.  It should
work on later versions of Python and wxPython.  If you are having issues, file
a bug report on <a class="reference" href="http://sourceforge.net/projects/pype">http://sourceforge.net/projects/pype</a> .</p>
</div>
<div class="section" id="installation">
<h1><a class="toc-backref" href="#id6" name="installation">Installation</a></h1>
<p>If you have Python 2.3 or later as well as wxPython 2.6.3 or later, you can
extract PyPE-X.Y.Z-src.zip anywhere and run it by double-clicking on pype.py
or pype.pyw .  If you want to be all official, you can use
'python setup.py install', but that is generally unnecessary.</p>
<p>If you don't have Python 2.3 wxPython 2.6.3 or later, and are running Windows,
you should (hopefully) be able to run the Windows binaries.  They are provided
for your convenience (so you don't have to install Python and wxPython).</p>
<p>If it so happens that the Windows binaries don't work for you, and you have an
installation of Python and wxPython that fits the requirements, why don't you
run the source version?  The only difference is a pass through py2exe, and a
minor loading time speed increase.  Just because the Windows binaries exist,
doesn't mean that you /have/ to run them.</p>
<div class="section" id="why-doesn-t-the-windows-install-work">
<h2><a class="toc-backref" href="#id7" name="why-doesn-t-the-windows-install-work">Why doesn't the Windows install work?</a></h2>
<p>Depending on your platform, it may or may not work.  It works for me on
Windows 2k, XP and 98.  Most problems people have is that they mistakenly
extract library.zip, which they shouldn't do.  It could also be due to the
lack of some DLL, in which case an error message should inform you of what DLL
you are missing.</p>
</div>
<div class="section" id="why-doesn-t-pype-work-on-linux">
<h2><a class="toc-backref" href="#id8" name="why-doesn-t-pype-work-on-linux">Why doesn't PyPE work on Linux?</a></h2>
<p>PyPE 2.5+ has been tested on Ubuntu 6.06 with...</p>
<ul class="simple">
<li>python-wxversion_2.6.1.2ubuntu2_all.deb</li>
<li>libwxgtk2.6-0_2.6.1.2ubuntu2_i386.deb</li>
<li>python-wxgtk2.6_2.6.1.2ubuntu2_i386.deb</li>
</ul>
<p>The only anomalies observed so far is seemingly a bug with some
wx.ScrolledPanel uses, specifically the 'Search' tab along the bottom not
displaying all of the options for searching within files.  Making the bottom
set of tools larger, then using a hotkey to show/hide the tools whenever
necessary is a workable (if not ugly and inconvenient) workaround.</p>
<p>PyPE 2.5+ has also been tested on Kubuntu 6.06 after the installation of the
Synaptic packaage manager, which may or may not have introduced other Gtk
libraries that may or may not affect its performance.  On Kubuntu, there are
a large number of errors and/or warnings during PyPE startup, but I have not
been able to crash PyPE yet, so I presume it is stable.</p>
<p>There have previously been reports of PyPE segfaulting in certain Linux
distributions when opening a file.  This seems to be caused by icons in the
file listing in the 'Documents' tab on the right (or left) side of the editor
(depending on your preferences), or by icons in the notebook tabs along the
top of the editor.  It was due to either the platform not being able to find
the icons to display, or the icons being improperly sized.  You can disable
these icons by starting up PyPE, going to Options-&gt;Use Icons, and making sure
that it is unchecked.  You should restart PyPE to make sure that the setting
sticks.  PyPE will be uglier, but it should work.  I believe that this has
been fixed in PyPE 2.4.1 and later, but this documentation persists &quot;just in
case&quot;.</p>
</div>
<div class="section" id="why-isn-t-the-most-recent-pype-available-as-deb-or-rpm">
<h2><a class="toc-backref" href="#id9" name="why-isn-t-the-most-recent-pype-available-as-deb-or-rpm">Why isn't the most recent PyPE available as deb or RPM?</a></h2>
<p>Short answer: it's a pain in the ass.</p>
<p>Longer answer: I'm not the maintainer for the PyPE package, but have recently
discovered that PyPE has a new debian maintainer.  Whether or not the new
debian maintainer keeps PyPE up-to-date is up to him.  Personal attempts to
create .debs have resulted in utter failure, which I can either blame on a
personal failure to comprehend the documentation, or a failure in the
documentation to impart the necessary information.  Either way, you are going
to have to wait for the debian/ubuntu/whatever repositories to update.  You
can always get the most recent PyPE from <a class="reference" href="http://sourceforge.net/projects/pype">http://sourceforge.net/projects/pype</a></p>
<p>I'm not going to package any RPMs for PyPE, primarily because I'm not going to
install the RPM build/install stuff into Ubuntu.  Recent attempts to get
bdist_wininst working in such a way that the results don't mangle Python
installations have failed, and this experience leads me to believe that
bdist_rpm has similar issues.  Essentially, you are on your own with regards
to rpm packages.</p>
</div>
<div class="section" id="why-doesn-t-pype-work-on-osx">
<h2><a class="toc-backref" href="#id10" name="why-doesn-t-pype-work-on-osx">Why doesn't PyPE work on OSX?</a></h2>
<p>I have had no reports of PyPE working or not working on any version of OSX.  I
don't have a Mac, and I'm not too keen on running a hacked version of OSX on
X86 hardware, so unless someone is willing to donate or test, I'll continue to
have no idea of whether it runs or not.</p>
</div>
</div>
<div class="section" id="command-line-options">
<h1><a class="toc-backref" href="#id11" name="command-line-options">Command Line Options</a></h1>
<div class="section" id="last">
<h2><a class="toc-backref" href="#id12" name="last">--last</a></h2>
<p>When PyPE is run with the '--last' command line option, PyPE will attempt to
load all documents that were opened the last time you shut down PyPE.  This is
equivalent to starting up PyPE and using File-&gt;Open Last .</p>
</div>
<div class="section" id="unicode-and-ansi">
<h2><a class="toc-backref" href="#id13" name="unicode-and-ansi">--unicode and --ansi</a></h2>
<p>If PyPE is started up with the --unicode or --ansi command line options, it
will attempt to use the unicode or ansi versions of wxPython respectively.  On
failure, it will display to the user with a failure notice.  These options
have no effect on the Windows distributions of PyPE, or wherever 
<tt class="docutils literal"><span class="pre">hasattr(sys,</span> <span class="pre">'frozen')</span></tt> is true.</p>
</div>
<div class="section" id="nothread">
<h2><a class="toc-backref" href="#id14" name="nothread">--nothread</a></h2>
<p>This command line option will disable the threaded parser, which may cause
problems on some platforms.  This will reduce the accuracy of the tools in
the &quot;Tools&quot; menu, due to the faster and not necessarily correct parser.</p>
</div>
<div class="section" id="macros">
<h2><a class="toc-backref" href="#id15" name="macros">--macros</a></h2>
<p>PyPE 2.6 has an almost fully-functioning macro system.  The Python 2.5
<tt class="docutils literal"><span class="pre">--macros</span></tt> command line option is now ignored because macros are enabled by
default in 2.6+.</p>
</div>
</div>
<div class="section" id="pype-features-and-functionality">
<h1><a class="toc-backref" href="#id16" name="pype-features-and-functionality">PyPE features and functionality</a></h1>
<div class="section" id="what-is-sloppy-cut-copy">
<h2><a class="toc-backref" href="#id17" name="what-is-sloppy-cut-copy">What is Sloppy Cut/Copy?</a></h2>
<p>When selecting multiple lines for a cut/copy operation, Sloppy Cut/Copy will
select the entirety of partially selected lines.  This saves the user from
having to meticulously select the start and end points of multi-line
selections.</p>
</div>
<div class="section" id="what-is-smart-paste">
<h2><a class="toc-backref" href="#id18" name="what-is-smart-paste">What is Smart Paste?</a></h2>
<p>Smart Paste is two functionalities in one.</p>
<ol class="arabic simple">
<li>When pasting multiple lines into a currently indented region, it will
reindent the pasted region such that the least indented line of the pasted
region matches the current indentation level, all other indent levels being
relative to the current/minimum.</li>
<li>When the cursor is in a non-indent portion of a line, and you paste, Smart
Paste will automatically paste to the next line, indenting one level deeper
as necessary if you had selected the start of a new block (like if, for,
while, def, etc., for Python, open curly braces '{' in C, etc.).</li>
</ol>
</div>
<div class="section" id="what-do-the-different-options-in-the-filter-tool-do">
<h2><a class="toc-backref" href="#id19" name="what-do-the-different-options-in-the-filter-tool-do">What do the different options in the Filter tool do?</a></h2>
<dl class="docutils">
<dt>subsequence</dt>
<dd>will match things like <tt class="docutils literal"><span class="pre">us.et</span></tt> to <tt class="docutils literal"><span class="pre">UserString.ExpandTabs</span></tt></dd>
<dt>no context</dt>
<dd>will not provide any context in the display or search</dd>
<dt>long</dt>
<dd>will provide a 'verbose' display and search context, like
<tt class="docutils literal"><span class="pre">class</span> <span class="pre">foo:</span> <span class="pre">def</span> <span class="pre">bar(self)</span></tt> .</dd>
<dt>short</dt>
<dd>will provide a concise display and search context, like
<tt class="docutils literal"><span class="pre">def</span> <span class="pre">foo.bar(self)</span></tt></dd>
<dt>exact</dt>
<dd>will find entries that include <em>exactly</em> what you typed in.</dd>
<dt>any</dt>
<dd>will find entries that include <em>any</em> of the 'words' you provide.</dd>
<dt>all</dt>
<dd>will find the entries that include <em>all</em> of the 'words' you provide</dd>
</dl>
<p>Given the following three definitions and the <tt class="docutils literal"><span class="pre">no</span> <span class="pre">context</span></tt> option without
subsequence searching:</p>
<pre class="literal-block">
def abc(ghi, jkl)
def jkl(mno, pqr)
def stu(vwx, yz)
</pre>
<p>...the following searches are true:</p>
<pre class="literal-block">
exact 'def abc' -&gt; #1
any 'def abc' -&gt; #1, #2, #3
all 'def abc' -&gt; #1

exact 'abc ghi' -&gt; Nothing
any 'abc ghi' -&gt; #1
all 'abc ghi' -&gt; #1

exact 'jkl stu' -&gt; Nothing
any 'jkl stu' -&gt; #1, #2, #3
all 'jkl stu' -&gt; Nothing
</pre>
<p>Please note that the line count information can be off significantly.  This is
due to the simple algorithm that it uses to &quot;count&quot; lines.  Really, all it
does is to say that the number of lines for definition A is the number of
lines from the start of definition A to the next definition.</p>
<p>For example, <tt class="docutils literal"><span class="pre">cls</span></tt> in the following example has 1 line, but <tt class="docutils literal"><span class="pre">fcn</span></tt> has 5:</p>
<pre class="literal-block">
class cls:
    def fcn(self):
        pass



def foo():
    pass
</pre>
</div>
<div class="section" id="dictionaries-and-alphabets-for-the-spell-checker">
<h2><a class="toc-backref" href="#id20" name="dictionaries-and-alphabets-for-the-spell-checker">Dictionaries and alphabets for the Spell checker</a></h2>
<p>You can create/delete custom dictionaries via the +/- buttons right next to
the &quot;Custom Dictionaries:&quot; section.  You can add words to these custom
dictionaries by &quot;Check&quot;ing your document for misspellings, checking all of the
words you want to add, clicking &quot;+ ./&quot;, then choosing the custom dictionary
you want the words added to.</p>
<p>If you want to use a large primary dictionary, create a 'dictionary.txt' file
that is utf-8 encoded, and place it into the same path that PyPE is.  This
will be far faster for startup, shutdown, and creating the list than manually
adding all of the words to custom dictionaries.  Fairly reasonable word lists
for english (British, Canadian, or American) are available at Kevin's Word 
list page: <a class="reference" href="http://wordlist.sourceforge.net/">http://wordlist.sourceforge.net/</a> Words should be separated by any
standard whitespace character (spaces, tabs, line endings, etc.).</p>
<p>If you want to customize the alphabet that PyPE uses for suggesting spelling,
you can create an 'alphabet.txt' file that is utf-8 encoded, where alphabet
characters separated by commas ',', and place it into the same path that PyPE
is.</p>
<p>Please note that the spell checker is very simple.  After discovering &quot;words&quot;,
which are contiguous sequences of letters, suggestions are created by removing
single letters, inserting single letters, and swapping pairs of letters
internally.  It then checks these suggestions against the user-supplied
dictionaries, and any that match become suggestions.</p>
</div>
<div class="section" id="how-does-one-pype-work">
<h2><a class="toc-backref" href="#id21" name="how-does-one-pype-work">How does &quot;One PyPE&quot; work?</a></h2>
<p>If &quot;One PyPE&quot; is selected, it will remove the file named 'nosocket' from the
path in which PyPE is running from (if it exists), and start a listening
socket on 127.0.0.1:9999 .  If &quot;One PyPE&quot; is deselected, it will create a file
called 'nosocket' in the path from which PyPE is running, and close the
listening socket (if one was listening).</p>
<p>Any new PyPE instances which attempt to open will check for the existence of
the nosocket file.  If it does not find that file, it will attempt to create a
new listening socket on 127.0.0.1:9999 .  If the socket creation fails, it
will attempt to connect to 127.0.0.1:9999 and send the documents provided on
the command-line to the other PyPE instance.  If it found the file, or if it
was able to create the socket, then a new instance of PyPE will be created,
and will use the preferences-defined &quot;One PyPE&quot; (preventing certain issues
involving a read-only path which PyPE is on, or a read-only nosocket file).</p>
<p>If you want to prevent new instances of PyPE from ever creating or using
sockets, create a file called 'nosocket' and make it read-only to PyPE.</p>
</div>
<div class="section" id="what-the-heck-is-a-trigger">
<h2><a class="toc-backref" href="#id22" name="what-the-heck-is-a-trigger">What the heck is a Trigger?</a></h2>
<p>Let us say that you writing a web page from scratch.  Let us also say that
typing in everything has gotten a bit tiresome, so you want to offer yourself
a few macro-like expansions, like 'img' -&gt; '&lt;img src=&quot;&quot;&gt;'.</p>
<ol class="arabic simple">
<li>Go to: Document-&gt;Set Triggers.</li>
<li>Click on 'New Trigger'.</li>
<li>In the 'input' column of the new trigger, type in <tt class="docutils literal"><span class="pre">img</span></tt></li>
<li>In the 'output' column, type in <tt class="docutils literal"><span class="pre">&lt;img</span> <span class="pre">src=&quot;%C&quot;&gt;</span></tt></li>
</ol>
<p>In the future, if you type in <tt class="docutils literal"><span class="pre">img</span></tt> and use Transforms-&gt;Perform Trigger, it
will expand itself to <tt class="docutils literal"><span class="pre">&lt;img</span> <span class="pre">src=&quot;&quot;&gt;</span></tt> with your cursor between the two double
quotes.</p>
<p>What other nifty things are possible?  How about automatic curly and square
brace matching with [, [%C] and {, {%C}?  Note that triggers with a single
character in the 'enter' column are automatically done as you type, but
triggers with multiple characters in the 'input' column require using
Transofrms-&gt;Perform Trigger (or its equivalent hotkey if you have assigned
one via Options -&gt; Change Menus and Hotkeys).</p>
<p>As described, there is a <tt class="docutils literal"><span class="pre">%C</span></tt> directive that defines where the cursor will
end up.  There is also a <tt class="docutils literal"><span class="pre">%L</span></tt> directive that inserts a line break with
autoindentation.  The semantics for string escapes are the same as in the
Find/Replace bar, and a non-indenting line break can be inserted with the
standard <tt class="docutils literal"><span class="pre">\n</span></tt>.</p>
</div>
<div class="section" id="find-replace-bars">
<h2><a class="toc-backref" href="#id23" name="find-replace-bars">Find/Replace bars</a></h2>
<p>If you have ' or &quot; as the first character in a find or find/replace entry, and
what you entered is a proper string declaration in Python, PyPE will use the
compiler module to parse and discover the the string.  For example, to
discover LF characters, use <tt class="docutils literal"><span class="pre">&quot;\n&quot;</span></tt>, including quotes.</p>
</div>
<div class="section" id="string-escapes-in-regular-expressions-and-multiline-searches">
<h2><a class="toc-backref" href="#id24" name="string-escapes-in-regular-expressions-and-multiline-searches">String escapes in regular expressions and multiline searches?</a></h2>
<p>You can use standard Python strings with escapes and quote marks just like
when you use the find/replace bars with one minor difference; all searched
data is normalized to have <tt class="docutils literal"><span class="pre">\n</span></tt> line endings regardless of the input.  This
means that if you want to find a colon followed by a line ending followed by
a space, you would use <tt class="docutils literal"><span class="pre">&quot;:\n</span> <span class="pre">&quot;</span></tt>, including quotes.</p>
<p>If you include line endings in your search string, then multiline searching
will be automatically enabled during the search (but the box will remain
checked or unchecked).</p>
</div>
<div class="section" id="what-happens-when-smart-case-is-enabled-during-a-replace">
<h2><a class="toc-backref" href="#id25" name="what-happens-when-smart-case-is-enabled-during-a-replace">What happens when &quot;Smart Case&quot; is enabled during a replace?</a></h2>
<p>If the found string is all upper or lower case, it will be replaced by a
string that is also all upper or lower case.</p>
<p>Else if the length of the found string is the same length as the replacement
string, you can replace one string for another, preserving capitalization.</p>
<p>For example...</p>
<pre class="literal-block">
def handleFoo(foo, arg2):
    tfOO = fcn(foo)
    tFOO2 = fcn2(tfOO)
    return fcn3(tfOO, tFOO2, foo)
</pre>
<p>...becomes...</p>
<pre class="literal-block">
def handleGoo(goo, arg2):
    tgOO = fcn(goo)
    tGOO2 = fcn2(tgOO)
    return fcn3(tgOO, tGOO2, goo)
</pre>
<p>...by enabling &quot;Smart Case&quot;, and putting 'foo' and 'goo' in the find/replace
boxes.</p>
<p>Otherwise if the first letter of the found string is upper or lowercase, then
its replacement will have the first letter be upper or lowercase respectively.</p>
</div>
<div class="section" id="what-is-up-with-the-enable-file-drops-checkbox-in-the-edit-menu">
<h2><a class="toc-backref" href="#id26" name="what-is-up-with-the-enable-file-drops-checkbox-in-the-edit-menu">What is up with the &quot;Enable File Drops&quot; checkbox in the 'Edit' menu?</a></h2>
<ol class="arabic simple">
<li>Select some text.</li>
<li>Now click on it.</li>
</ol>
<p>Q: Do you want the selection to go away, and your cursor to be close to where
you clicked?</p>
<p>A1: If yes, uncheck the box and restart if necessary.</p>
<p>A2: If no, check the box and restart if necessary.</p>
<p>(The check is effective for any opened document from then on, but does not
change the behavior of already opened documents.)</p>
<p>One should always be able to drag and drop text.  One should always be able to
drag and drop files everywhere, except for the text editor portion.  If
checked, you can drop files on the editor portion, if unchecked, you won't be
able to drop files on the text editor portion.</p>
</div>
<div class="section" id="how-do-i-use-the-todo-list">
<h2><a class="toc-backref" href="#id27" name="how-do-i-use-the-todo-list">How do I use the 'Todo' list?</a></h2>
<p>On a line by itself (any amount of leading spaces), place something that
matches the following regular expression: <tt class="docutils literal"><span class="pre">([a-zA-Z0-9</span> <span class="pre">]+):(.*)</span></tt> and is
immediately preceeded with a language-specific single-line comment (<tt class="docutils literal"><span class="pre">#</span></tt>,
<tt class="docutils literal"><span class="pre">//</span></tt>, <tt class="docutils literal"><span class="pre">%</span></tt>, or <tt class="docutils literal"><span class="pre">&lt;!--</span></tt>).</p>
<p>The first group (after a .strip().lower() translation) will become category in
the 'Category' column, the second group (after a .strip()) becomes the todo in
the 'Todo' column, and the number of exclamation points will become the number
in the '!' column.</p>
<p>PyPE also tosses all entries with a 'Category' that is also a keyword
(keyword.kwlist), or one of the following: http, ftp, mailto, news, gopher,
and telnet.</p>
<p>The following lines are all valid todos</p>
<pre class="literal-block">
# todo: fix the code below
        #todo:fix the code below!
    #        TODo: fix the code below
#bug:I am a big ugly bug...no, I really am, but I'm also a todo
# this thing can even have spaces: but it cannot have punctuation!

#I am not a valid todo...: because there is punctuation on the left
</pre>
</div>
<div class="section" id="what-are-the-known-issues-within-pype-s-parser">
<h2><a class="toc-backref" href="#id28" name="what-are-the-known-issues-within-pype-s-parser">What are the known issues within PyPE's parser?</a></h2>
<div class="section" id="the-c-c-parser">
<h3><a class="toc-backref" href="#id29" name="the-c-c-parser">The C/C++ parser</a></h3>
<p>The recently added C/C++ parser uses a combination of regular expressions and
a few checks to extract function definition information.  Note that it can
handle things like the following and their variations:</p>
<pre class="literal-block">
int ** foo(char* arg1, int larg1) \{ ...

str1 myClass :: operator[] (indices, count)
int* indices;
int count;
\{ ...
</pre>
<p>Generally speaking, it searches for all matches of the following regular
expressions for function-like examples of <tt class="docutils literal"><span class="pre">#define</span></tt> and functions
respectively:</p>
<pre class="literal-block">
(#ys+i\(i(?:,s*i)*\))
(?:(cs*\([^\)]*\))[^{;\)]*[;{])
</pre>
<p>Where the following replacements are made, in-order to the regular expressions
prior to matching:</p>
<pre class="literal-block">
c -&gt; (?:i|operator[^\w]+)
i -&gt; (?:[a-zA-Z_]\w*)
s -&gt; [ \t]
y -&gt; (?:[dD][eE][fF][iI][nN][eE])
</pre>
<p>The function-like macros are returned unchanged, while the possible function
matches have various other tests performed on them, and the addition of
everything on the same line as the potential function definition.</p>
<p>Note that the parser doesn't recognize struct definitions, data members of
classes, class hierarchies, functions with default values, etc.  It should be
sufficient for most navigation and/or</p>
</div>
<div class="section" id="the-python-parser">
<h3><a class="toc-backref" href="#id30" name="the-python-parser">The Python parser</a></h3>
<p>For Python source files, if given a syntactically correct Python source file,
the Python parser should work without issue (as long as --nothread is not
provided), though it may not be quite as fast as desired (where fast is &lt; .1
seconds).  Recent versions of PyPE have a much faster &quot;slow&quot; parser than
previous versions, but it is still limited to syntactically correct source
files.</p>
<p>If not given a syntactically correct Python source file (or if --nothread was
provided as a command line option), the parser splits the file into lines,
performing a check to see if there is a function, class, or comment on that
line, then saves the hierarchy information based on the level of indentation
and what came before it.  This can be inaccurate, as it will mistakenly
believe that the below function 'enumerate' is a method of MyException.</p>
<pre class="literal-block">
class MyException(Exception):
    pass
try:
    enumerate
except:
    def enumerate(inp):
        return zip(range(len(inp)), inp)
</pre>
<p>It also doesn't know anything about multi-line strings, so the definition nada
in the following lines would be seen as a function, and not part of a string.</p>
<pre class="literal-block">
'''
this used to be a function
def nada(inp):
    return None
'''
</pre>
<p>This parser will also not pull out doc strings or handle multi-line function
definitions properly.</p>
<p>PyPE still needs a real parser for C, so it only extracts \todo: items.  What
precisely a parser would do on TeX/LaTeX, HTML or XML is beyond me, so they
also only extract %todo: and &lt;!-- todo: --&gt; items respectively.</p>
</div>
</div>
<div class="section" id="how-do-you-get-usable-calltips">
<h2><a class="toc-backref" href="#id31" name="how-do-you-get-usable-calltips">How do you get usable Calltips?</a></h2>
<p>Hit F5.  This will also rebuild the browsable source tree, autocomplete
listing, and todo list.</p>
</div>
<div class="section" id="how-do-you-get-autocompletion">
<h2><a class="toc-backref" href="#id32" name="how-do-you-get-autocompletion">How do you get autocompletion?</a></h2>
<p>Easy.  In the 'Document' menu, there is an entry for 'Show autocomplete'.
Make sure there is a check by it, and you are set.  If you want to get a new
or updated listing of functions, hit the F5 key on your keyboard.</p>
</div>
<div class="section" id="crlf-lf-cr-line-endings">
<h2><a class="toc-backref" href="#id33" name="crlf-lf-cr-line-endings">CRLF/LF/CR line endings</a></h2>
<p>PyPE will attempt to figure out what kind of file was opened, it does this by
counting the number of different kinds of line endings.  Which ever line
ending appears the most in an open file will set the line ending support for
viewing and editing in the window.  Also, any new lines will have that line
ending.  New files will have the same line endings as the host operating
system.</p>
<p>Additionally, copying from an open document will not change the line-endings.
Future versions of PyPE may support the automatic translation of text during
copying and pasting to/from the host operating system's native line endings.</p>
<p>Converting between line endings is a menu item that is available in the
'Document' menu.</p>
</div>
<div class="section" id="stcstyleeditor-py">
<h2><a class="toc-backref" href="#id34" name="stcstyleeditor-py">STCStyleEditor.py</a></h2>
<p>As I didn't write this, I can offer basically no support for it.  It seems to
work to edit python colorings, and if you edit some of the last 30 or so lines
of it, you can actually use the editor to edit some of the other styles that
are included.</p>
<p>If it doesn't work for you, I suggest you revert to the copy of the editor and
stc-styles.rc.cfg that is included with the distribution of PyPE you received.
As it is a known-good version, use it.</p>
</div>
<div class="section" id="expandable-collapsable-foldable-code">
<h2><a class="toc-backref" href="#id35" name="expandable-collapsable-foldable-code">Expandable/collapsable/foldable code</a></h2>
<p>Since the beginning, there have been expandable and collapsable scopes thanks
to wxStyledTextCtrl.  How to use them...
Given the below...</p>
<pre class="literal-block">
- class nada:
-     def funct(self):
-         if 1:
|             #do something
|             pass
</pre>
<p>Shift-clicking the '-' next to the class does this...</p>
<pre class="literal-block">
- class nada:
+     def funct(self):
</pre>
<p>Or really, it's like ctrl-clicking on each of the functions declared in the
scope of the definition.  Shift-clicking on the '-' a second time does
nothing. Shift-clicking on a '+' expands that item completely.</p>
<p>Control-clicking on a '+' or '-' collapses or expands the entirety of the
scopes contained within.</p>
<p>I don't know about you, but I'm a BIG fan of shift-clicking classes.  Yeah.
Play around with them, you may like it.</p>
</div>
<div class="section" id="converting-between-tabs-and-spaces">
<h2><a class="toc-backref" href="#id36" name="converting-between-tabs-and-spaces">Converting between tabs and spaces</a></h2>
<p>So, you got tabs and you want spaces, or you have spaces and want to make them
tabs.  As it is not a menu option, you're probably wondering &quot;how in the hell
am I going to do this&quot;.  Well, if you read the above stuff about string
escapes in the find/replace bar, it would be trivial.
Both should INCLUDE the quotation marks.
To convert from tabs to 8 spaces per tab; replace <tt class="docutils literal"><span class="pre">&quot;\\t&quot;</span></tt> with <tt class="docutils literal"><span class="pre">&quot;</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span class="pre">&quot;</span></tt>
To convert from 8 spaces to one tab; replace <tt class="docutils literal"><span class="pre">&quot;</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span class="pre">&quot;</span></tt> with <tt class="docutils literal"><span class="pre">&quot;\\t&quot;</span></tt></p>
<p>Note that you don't need to use the double quotes for the spaces, but it
allowed me to be explicit in this documentation.</p>
</div>
</div>
<div class="section" id="how-do-i-program-my-own-macros">
<h1><a class="toc-backref" href="#id37" name="how-do-i-program-my-own-macros">How do I program my own macros?</a></h1>
<p>Users of PyPE 2.5.1 (a test release) and later will have the ability to
record, edit, playback, and delete macros.  Most keyboard related tasks are
recorded (typing, keyboard movement, selection, cut, copy, paste, etc.), as
are all items in the Transforms menu; including automatic and manual triggers.</p>
<p>Any macro without any action performed will not be recorded.  That is, if you
hit &quot;Start Recording&quot; and do nothing other than hit &quot;Stop Recording&quot;, a macro
will not be created.  If you would like to create an initially empty macro,
you can use &quot;Empty Macro&quot; and it will get everything all set up for you.</p>
<p>Before you execute your macro, I encourage you to save all currently open
documents.  While I haven't experienced any recent crashes or segfaults while
using macros, I may not be able to replicate your particular crash condition
even if given the macro source, so may not be able to fix your problem.  Be
careful!</p>
<p>Let us assume that you have created an initially empty macro with the &quot;Empty
Macro&quot; button, whose contents are something like the following:</p>
<pre class="literal-block">
creation_date = 'Wed Jul 12 21:35:34 2006'
name = 'macro: Wed Jul 12 21:35:34 2006'

def macro(self):
    pass
</pre>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">creation_date</span></tt></dt>
<dd>is merely for reference purposes</dd>
<dt><tt class="docutils literal"><span class="pre">name</span></tt></dt>
<dd>is the name you will see in the macro list.  If this value is
missing, you will see the file name instead.</dd>
<dt><tt class="docutils literal"><span class="pre">def</span> <span class="pre">macro(self):</span></tt></dt>
<dd>is the initial definition of the macro.  You can have any number of helper
functions, extra data, etc., but the macro itself must be named <tt class="docutils literal"><span class="pre">macro</span></tt>,
and must take at least one argument, the first of which being the
<tt class="docutils literal"><span class="pre">wxStyledTextCtrl</span></tt> instance that contains the current document.  You can
also import any module that is available (which may be limited on systems
using the Windows binary).</dd>
</dl>
<p>The <tt class="docutils literal"><span class="pre">self</span></tt> parameter will actually be my own custom subclass of the
<tt class="docutils literal"><span class="pre">StyledTextCtrl</span></tt>.  You will never recieve a shell or interpreter, and you
will not be able to execute macros on shells or interpreters.</p>
<p>Generally speaking, the <tt class="docutils literal"><span class="pre">wxStyledTextCtrl</span></tt> subclass has everything that the
normal control subclass has, with a few caveats.</p>
<ol class="arabic">
<li><p class="first"><tt class="docutils literal"><span class="pre">self.GetText()</span></tt> and <tt class="docutils literal"><span class="pre">self.SetText()</span></tt> will return and set the content
of the document, paying attention to encodings as necessary.  That is, if
you perform <tt class="docutils literal"><span class="pre">y</span> <span class="pre">=</span> <span class="pre">self.GetText()</span></tt> inside a macro on a document including
unicode characters, or a document defining one of the standard Python
document encoding methods, you will recieve the encoded version of your
document.  Strictly ASCII documents or those without any encodings will
produce the document as-is.</p>
<p>If you would like to acquire the contents of the file as-is, unicode on
unicode platforms, etc.:</p>
<pre class="literal-block">
import wx.stc

def macro(self):
    content = wx.stc.StyledTextCtrl.GetText(self)
</pre>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">self.lines</span></tt> is a special property that gives you a line-based view of
the current document.:</p>
<pre class="literal-block">
line = self.lines[i]        # will return line &quot;i&quot; including whitespace
lines = self.lines[i:j]     # will return lines i...j-1, using standard Python slice semantics
bad = self.lines[i:j:-1]    # will raise an exception (only steps == 1 are acceptable)

self.lines[0] = 'hello world\n' # will set the first line to be &quot;hello world&quot;
self.lines[0] = 'hello world '  # will set the first line to be &quot;hello world &quot;,
                                # and the next line will become the tail end of the first line

del self.lines[i] # same as self.lines[i] = ''

#other special properties of self.lines:
self.lines.curline          # manipulation of the line the cursor is on
self.lines.curlinei         # manipulation of the index where the cursor is
self.lines.curlinep         # manipulation of the column in the line where the cursor is
self.lines.selectedlines    # manipulation of the lines where a selection exists
self.lines.selectedlinesi   # manipulation of the indices where a selection exists

#to force the selection of all of all lines where a selection currently exists:
self.lines.selectedlinesi = self.lines.selectedlinesi

#to iterate over the indices of all selected lines:
for i in xrange(*self.lines.selectedlinesi):
    ...

#etcetera.
</pre>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">self.InterpretTrigger(text)</span></tt> will interpret the text you provide as it
would interpret a trigger, with a small change.  That is,:</p>
<pre class="literal-block">
self.InterpretTrigger('def foo(%C):\npass')
</pre>
<p>will produce the following, with the cursor where the <tt class="docutils literal"><span class="pre">&#64;</span></tt> is, without
the <tt class="docutils literal"><span class="pre">&#64;</span></tt> sign.:</p>
<pre class="literal-block">
def foo(&#64;):
    pass
</pre>
<p>If you want your <tt class="docutils literal"><span class="pre">'\n'</span></tt> line endings to not include auto-indenting (as
is the default for normal triggers), use <tt class="docutils literal"><span class="pre">self.InterpretTirgger(text,</span> <span class="pre">1)</span></tt>.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">self._autoindent(0)</span></tt> will perform the equivalent of
<tt class="docutils literal"><span class="pre">self.InterpretTrigger('\n')</span></tt>.</p>
</li>
</ol>
<div class="section" id="an-example-nontrivial-macro">
<h2><a class="toc-backref" href="#id38" name="an-example-nontrivial-macro">An example nontrivial macro</a></h2>
<p>When I was writing macro support, I would have found macros to be quite
convenient for developing macros.  What do I mean?  Let us say that I wanted
to turn a line that read (from main_window_callback.c in the gPHPedit sources):</p>
<pre class="literal-block">
case (2316) : gtk_scintilla_document_start(GTK_SCINTILLA(main_window.current_editor-&gt;scintilla)); break;
</pre>
<p>Into a line that read:</p>
<pre class="literal-block">
2316: 'DocumentStart',
</pre>
<p>As I ended up doing by hand.  Well, I could write the following macro, select
those lines I wanted to update, and execute the macro.:</p>
<pre class="literal-block">
def macro(self):
    lines = self.lines
    newlines = []
    for i in xrange(*lines.selectedlinesi):
        line = lines[i]
        pieces = line.split()
        num = pieces[1].strip('()')
        name = pieces[3]
        name = name.split('(', 1)[0].title()
        name = ''.join(name.split('_')[2:])
        newlines.append(&quot;    %s: '%s',&quot;%(num, name))
    lines.selectedlines = newlines
</pre>
<p>Presumably one would want to include error handling in your nontrivial macros,
but they shouldn't be terribly difficult.</p>
</div>
<div class="section" id="using-macros-as-code-snippets">
<h2><a class="toc-backref" href="#id39" name="using-macros-as-code-snippets">Using macros as code snippets</a></h2>
<ol class="arabic simple">
<li>Create a macro.</li>
<li>Paste the content of your snippet into a global variable in the macro and
call it something like <tt class="docutils literal"><span class="pre">snippet</span></tt>.</li>
<li>Use <tt class="docutils literal"><span class="pre">self.InterpretTrigger(snippet)</span></tt>.</li>
</ol>
<p>That is, let us say that you wanted a snippet that inserted the following
content:</p>
<pre class="literal-block">
def foo(bar):
    pass
</pre>
<p>You would create the following macro:</p>
<pre class="literal-block">
name = 'Code Snippet foo()'

snippet = '''
def foo(bar):
    pass
'''

def macro(self):
    self.InterpretTrigger(snippet, 1)
</pre>
</div>
</div>
<div class="section" id="faq">
<h1><a class="toc-backref" href="#id40" name="faq">FAQ</a></h1>
<div class="section" id="how-do-you-come-up-with-new-feature-ideas">
<h2><a class="toc-backref" href="#id41" name="how-do-you-come-up-with-new-feature-ideas">How do you come up with new feature ideas?</a></h2>
<p>Every once and a while, I'll be editing with PyPE, and I'll say, &quot;hey, it
would be neat if I could do X with PyPE&quot;.  This is rare, though it has
produced things like the draggable document list, spell check, customizable
menu hotkey bindings, open module, &quot;One PyPE&quot;, etc.</p>
<p>More often than not, I will be surfing the net, and someone will rant and rave
about their super ultra mega favorite editor X, and how it has so many
features that are so great that no other editor has.  Out of curiosity, I'll
usually go to the specific site, look at the editor, the features it offers,
and consider if I would want PyPE to have such features, what changes would be
necessary, and what it would take to make them happen.  This has produced
things like workspaces, shells, find/replace bars (idea from Firefox),
triggers (and everything else in the Transforms menu), the name and line
oriented browsable source trees, etc.</p>
<p>Occasionally, some user of PyPE will contact me, perhaps report a bug, or
somesuch, and eventually either suggest features or offer up patches.  While
I had written the original Search tab, the current Search tab and the table
display of results were submitted almost complete.  Suggestions have resulted
in the addition of Start/End selection, bookmarks, the line-based abstraction
for macros, macros themselves, tools whose positions can be switched, title
options, the optional toolbar, caret tracking and width options, find/replace
bar history, the actual find/replace bar keybindings and what they do based on
context, the embedded HTML help, the Find Definition/filter tool, etc.</p>
<p>Astute observers will note that I have not really come up with anything
terribly original myself.  However, through observing other editors and IDEs,
and recieving great suggestions from users, I think that PyPE has managed to
acquire some very useful features.  Generally, I have written PyPE primarily
for myself, so if tools have a particular aesthetic or design, it's so that
look and work according to how I think they should (the exception being how
document preferences are handled, I really need to change that design).  I
hope that others find PyPE as natural to use as I do, but if not, then I
welcome your feedback.</p>
</div>
<div class="section" id="what-s-the-deal-with-the-version-numbering-scheme">
<h2><a class="toc-backref" href="#id42" name="what-s-the-deal-with-the-version-numbering-scheme">What's the deal with the version numbering scheme?</a></h2>
<p>Early in development, PyPE raised version numbers very quickly.  From 1.0 to
1.5, not much more than 2 months passed.  In that time, most of the major
initial architectural changes that were to happen, happened.  This is not the
reason for the version number change.  Really it was so that the MAJOR
versions could have their own point release (1.0 being the first), and minor
bugfixes on the point releases would get a minor release number (like 1.0.1).</p>
<p>Then, at around PyPE 1.4.2, I had this spiffy idea.  What if I were to release
a series of PyPE versions with the same version numbers as classic Doom?  I
remembered updating to 1.1, then to 1.2a, etc.  My favorite was 1.666.  Ah
hah! PyPE 1.6.6.6, the best version of PyPE ever.</p>
<p>I decided that I would slow version number advancement, if only so that people
didn't get sick of new releases of PyPE being numbered so much higher when
there were minimal actual changes.  Then the more I thought about it, the more
I realized that it doesn't matter at all, I mean, Emacs is on version 20+.
*shrug*</p>
<p>When PyPE 1.9.3 came out, I had a few other ideas for what I wanted to happen,
but since major changes to the underlying architecture were required, it
really should get a major number bump to 2.0.  After spending 3 months not
working on PyPE May-July 2004, I got some time to muck around with it here and
there.  After another few months of trying to rebuild it to only require a
single STC (with multiple document pointers, etc.) I realized that I'd have to
rebuild too much of PyPE to be able to get 2.0 out the door by 2010.  So I
started modifying 1.9.3.  All in all, around 85% of what I wanted made it into
PyPE 2.0, the rest was either architectural (ick), or questionable as to
whether or not anyone would even want to use the feature (even me).</p>
</div>
<div class="section" id="how-did-pype-come-about">
<h2><a class="toc-backref" href="#id43" name="how-did-pype-come-about">How did PyPE come about?</a></h2>
<p>The beginnings of PyPE were written from 10:30PM on the 2nd of July through
10:30PM on the 3rd of July, 2003.  Additional features were put together on
the 4th of July along with some bug fixing and more testing for version 1.0.
Truthfully, I've been using it to edit itself since the morning of the 3rd of
July, and believe it is pretty much feature-complete (in terms of standard
Python source editing).  There are a few more things I think it would be nice
to have, and they will be added in good time (if I have it).</p>
<p>One thing you should never expect is for PyPE to become an IDE.  Don't expect
a UML diagram.  Don't expect a debugger.  Don't expect debugging support
(what, print statements not good enough for you?)</p>
<p>On the most part, this piece of software should work exactly the way you
expect it to...or at least the way I expect it to.  That is the way I wrote
it.  As a result, you don't get much help in using it (mostly because I am
lazy).  There was a discussion of a PyPE wiki a long time ago, but that will
likely never happen (I've lost contact with the people who initially put
forward the wiki idea, and I have no interest in starting or maintaining one).</p>
<p>The majority of the things that this editor can do are in the menus.  Hotkeys
for things that have them are listed next to their menu items, and you can
both rename menu items and change their hotkeys via Options-&gt;Change Menus and
Hotkeys.</p>
</div>
</div>
<div class="section" id="thank-yous">
<h1><a class="toc-backref" href="#id44" name="thank-yous">Thank Yous</a></h1>
<p>Certainly there are some people I should thank, because without them, the
piece of software you are using right now, just wouldn't be possible.</p>
<p>Guido van Rossum - without Guido, not only would I not have Python, I also
wouldn't have had some of the great inspiration that IDLE has offered.  IDLE
is a wonderful editor, has some excellent ideas in terms of functionality, but
it unfortunately does not offer the extended functionality I want, and it
hurts my brain to use tk, so I cannot add it myself.  Guido, my hat goes off
to you.</p>
<p>The people writing wxWidgets (previously named wxWindows) and wxPython -
without you, this also would not have been possible.  You have made the most
self-consistent GUI libraries that I have ever used, made them easy to use,
and offer them on every platform that I would ever want or need.  You rock.</p>
<p>Neil Hodgson and others who work on Scintilla.  As wx.StyledTextCtrl is a
binding for scintilla in wxWidgets, which then has bindings for wxPython,
basically ALL the REAL functionality of the editor you are now using is the
result of Scintilla.  The additional things like tabbed editing, hotkeys,
etc., they are mere surface decorations in comparison to what it would take to
write everything required for a text editor from scratch.  Gah, an editor
widget that just works?  Who would have figured?</p>
<p>To everyone who I have already thanked: thank you for making PyPE an almost
trivial task.  It would have been impossible to go so far so fast by hand in
any other language using any other GUI toolkit or bindings.</p>
<p>And my wife - because without her, I would likely be a pathetic shell of a
man...or at least single, bored, and uncouth.  Well, I'm probably still
uncouth, but there's only so much a good woman can fix.</p>
</div>
</div>
<hr class="docutils footer" />
<div class="footer">
Generated on: 2006-08-01 07:27 UTC.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
</body>
</html>