r8813 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r8812‎ | r8813 | r8814 >
Date:19:37, 2 May 2005
Author:eloquence
Status:old
Tags:
Comment:
Detailed installation instructions for Unix and Windows.
Change default language to English.
Modified paths:
  • /trunk/extensions/ee/INSTALL (added) (history)
  • /trunk/extensions/ee/README (modified) (history)
  • /trunk/extensions/ee/README.de (modified) (history)
  • /trunk/extensions/ee/ee.pl (modified) (history)

Diff [purge]

Index: trunk/extensions/ee/ee.pl
@@ -26,7 +26,7 @@
2727
2828 $DEBUG=0;
2929 $NOGUIERRORS=0;
30 -$LANGUAGE="de";
 30+$LANGUAGE="en";
3131
3232 # Read config
3333 my $cfg = new Config::IniFiles( -file => $cfgfile );
Index: trunk/extensions/ee/README.de
@@ -22,4 +22,7 @@
2323 programme, in dem Sie in ee.cfg Applikationen mit MIME-Typen
2424 assoziieren. Um Dateien hochzuladen, muessen auch Authentifizierungs-
2525 Informationen fuer die gewuenschten Websites in der Konfigurationsdatei
26 -eingetragen werden.
\ No newline at end of file
 26+eingetragen werden.
 27+
 28+Installation: Lesen sie die Datei INSTALL f�r detaillierte Installations-
 29+Anweisungen unter Unix und Windows (Englisch).
\ No newline at end of file
Index: trunk/extensions/ee/INSTALL
@@ -0,0 +1,129 @@
 2+Installation of ee.pl reference implementation
 3+Erik M�ller - moeller(at)scireview(dot)de
 4+
 5+See README for the purpose and usage of the program.
 6+
 7+Be advised that ee.pl is primarily a proof of concept. It is usable, but it
 8+may be difficult to set up, particularly under Microsoft Windows. I hope
 9+that other people will write implementations of the external editor protocol
 10+as well.
 11+
 12+MediaWiki presently (V1.5) supports external editors for images and text,
 13+and external diff tools. You can enable external editing for text and
 14+external diffs in your user preferences. You can launch external editors
 15+for images by clicking the link at the bottom of the image history.
 16+
 17+If you want to be able to choose selectively when to use external editing
 18+for text, you may want to try hacking your Monobook.css/js to add a tab that
 19+points to the "action=edit&externaledit=true" for the page you're viewing.
 20+A bookmarklet would also work.
 21+
 22+ee.pl is a Perl script with the following dependencies:
 23+
 24+- a recent distribution of Perl (>V5.004)
 25+- the following modules:
 26+ - LWP (should be bundled with recent Perl distributions)
 27+ - Config::IniFiles
 28+ - Gtk2
 29+ - Encode
 30+- Gtk2 libraries for graphical user itnerfaces
 31+
 32+== Installation under Unix ==
 33+
 34+1) Install Perl if required, www.perl.com is your friend
 35+
 36+2) Become Root and run the CPAN shell with
 37+
 38+ perl -MCPAN -e shell
 39+
 40+3) Install the individual modules above with:
 41+
 42+ install Config::IniFiles
 43+ install Encode
 44+
 45+4) As for libgtk2-perl, it may be easiest to get binaries for your
 46+ platform. See the FAQ at
 47+ http://live.gnome.org/GTK2_2dPerl_2fFrequentlyAskedQuestions
 48+ for more information. Under Debian, it's particularly easy.
 49+ Just become root and type:
 50+
 51+ apt-get install libgtk2-perl
 52+
 53+ Any dependencies should be automagically resolved. If you're
 54+ brave, you can also try to compile everything from source;
 55+ http://gtk2-perl.sourceforge.net/ and the FAQ will have
 56+ information to guide you through the process.
 57+
 58+If everything is set up properly, you should get a graphical error message
 59+if you run ee.pl without any command line parameters.
 60+
 61+Edit ee.ini to define wikis (usernames and passwords) and applications. The
 62+bundled ee.ini file contains comments and should be largely
 63+self-explanatory. It needs to reside in the path which is set as $cfgfile
 64+in your ee.pl; by default, that is ~/.ee-helper/.
 65+
 66+Now, when you click an external-editor-powered link in your browser,
 67+associate the MIME type application/x-external-editor with your ee.pl
 68+executable.
 69+
 70+== Installation under Windows ==
 71+
 72+1) Get ActivePerl from
 73+http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl
 74+
 75+2) Open a command line window and type
 76+
 77+ ppm
 78+
 79+ Now type the following commands:
 80+
 81+ install Config-IniFiles
 82+ install Encode
 83+ rep add Gtk http://gtk2-perl.sourceforge.net/win32/ppm/
 84+ install Gtk2
 85+
 86+ Note that these may take a while to produce any output on the screen.
 87+ If a firewall warning pops up, approve the program to access the
 88+ Internet. If you have a proxy set up, see the ActivePerl docs
 89+ for configuring ppm to use it.
 90+
 91+
 92+3) Edit ee.pl in a text editor and change the variable $cfgfile to point it
 93+ to the location of ee.ini. Example:
 94+
 95+ $cfgfile='C:\ee\ee.ini';
 96+
 97+ Note that you have to use single quotes, or the backslash will be
 98+ interpreted as a special character.
 99+
 100+4) If you run ee.pl without parameters, a graphical error message should
 101+ pop up. If that is the case, you're almost there already.
 102+
 103+5) Edit ee.ini and adapt the programs, wikis and paths. You can use regular
 104+ Windows paths like C:\Program Files\My Program\program.exe. As noted
 105+ above, the file should be largely self-explanatory.
 106+
 107+ For the browser configuration, don't use the -openurl syntax in the
 108+ example file if running Firefox. Instead, just run the Firefox executable
 109+ with the URL as the only parameter (C:\bla\firefox.exe $url).
 110+
 111+6) Edit ee.bat and adapt the paths to point to the right files (your
 112+ Perl executable and your ee.pl).
 113+
 114+Now, when you click an external-editor-powered link in your browser,
 115+associate the MIME type application/x-external-editor with your ee.bat
 116+executable (not ee.pl -- I found this to be unreliable in different
 117+browsers).
 118+
 119+I haven't managed to get rid of the annoying pop up console window
 120+under Windows. If you find a way to do that, please let me know.
 121+
 122+== General comments ==
 123+
 124+Change the $LANGUAGE variable in ee.pl to set the program language (use a
 125+language code like "en" or "de").
 126+
 127+Caveat: Versions of Firefox I've tested are very buggy when indicating the
 128+MIME type. It may be displayed as "PHP script" instead of
 129+application/x-external-editor -- it will still be correctly associated,
 130+though.
\ No newline at end of file
Property changes on: trunk/extensions/ee/INSTALL
___________________________________________________________________
Added: svn:eol-style
1131 + native
Added: svn:keywords
2132 + Author Date Id Revision
Index: trunk/extensions/ee/README
@@ -22,3 +22,5 @@
2323 save files back to the server, you also have to add authentication
2424 information to the configuration file.
2525
 26+Installation: See INSTALL for detailed setup instructions under
 27+Unix and Windows.
\ No newline at end of file

Status & tagging log