Readme.txt in rwdschedule-0.91 vs Readme.txt in rwdschedule-0.92

- old
+ new

@@ -1,133 +1,103 @@ -= RwdTinker framework for RubyWebDialogs += rwdschedule - for rwdtinker and RubyWebDialogs +rwdschedule is a simple little database -RwdTinker is a web brower interface to and system for developing programs - -== Usage - - -How to Use the Tinker framework Program (rwdtinker) - - -1. stand alone application -2. framework for building applications -3. Open brower windows with html documents - The GUI interface used is RubyWebDialogs +RubyWebDialogs is a platform independent graphical user interface for Ruby applications. It generates HTML and serves it with an internal HTTP server, so you can use your favorite web browser as the front end for your Ruby application. All this means, that it can be used on almost every platform, like Ruby itself. http://www.erikveen.dds.nl/rubywebdialogs/ -Start the program by typing -ruby init.rb +== Quick Start + Start the program by typing + ruby init.rb -Then point your web browser to: -http://localhost:7705/ + Then point your web browser to: + http://localhost:7705/ +Then enter the event date you want to search for in the browser form and press Search. + 200412december1a +browser should fill with the event information. +To exit, press the x inside the browser window. + + +== How to Use the Schedule Book (rwdschedule) + +There are two ways to add records to schedule book. + +== Adding Records + +1. Use the "Edit Event" tab + The first field is the most important. It is the filename that + will be created. I use the event date starting with yearmonthday + 2005january11 + + The following lines for entry are for you to fill in as you want. + When you are finished press the Save Changes button + + You use this same screen for editing an already saved event + +2. Manually add an entry for a event record + You can use a text editor to create a record + put information on separate lines. You can have as many lines as you want + name the file with starting with date and end with .nam + 2005january11 6 pm dinner party.nam + + Save your file to the schedules/ subdirectory + + +== Viewing an schedule book entry: + + +Go to "View event" tab + + Click on the list events button. + + Click on the date you want + + Then click the "Open" button + + If it finds the record it will open it. It displays the record + as text under the "Open" button. + + +== Event Utilities + +Click on "Event Utilites" tab + + You can rename event filenames + You can delete events + +== Sync for multiple computers -== Viewing installed Applets: - + If you are like me, you have more than one system + I use rwdTinker at home on my Linux laptop + at work I use it on XP + on the go I use rwdtinker on my Zaurus PDA + So I am adding schedule events on different machines. + There is a function to help sync the separate systems + + in "Selection Panel" click on "Open Schedule Sync Window" -Go to "List Scripts" tab - - - You can get a list of all installed applets by clicking the listfiles button - - To see the text of a install file - Type in the name of the file you want. - - type it without the inf ending - rwdapplet-0.1 - - Then click the "View Installed File" button - - If it finds the file it will open it. It displays the text the search box. - - You can uninstall applets on this screen - -== Installing Applets - - click on the "Selection Panel" - click on Rwdtinker Back Window - - You can download an applet created by someone else - put the file in the zips directory - - click on the "list zips" tab - click on "list applets available for installing" - - chose the applet you want - click on "install applet" - If all goes well the applet should be installed. - You will need to restart rwdtinker to see the new screens - - -== Changing configuration file - - click on "Edit Configuration" - You can view the configuration file + First you need your ftp details set in the + configuration/rwdschedule.cnf file - You can edit the configuration - - Remember to reload the configuration variables if you want your - changes used. + you can upload your events from your local schedules directory to the ftp site + you can download events from the ftp site to your local updates directory + you can perform a sync which finds remote events and adds them to your local + schedules directory -== Manually installing applets - -* unzip an applet - - unzip the applet into the program directoy - unzip randomapplet.zip - - This should place the needed files in the correct directories - +== Show Month -== Creating Applets - -To add code, commands and gui tabs - -Move program files into a directory under the code directory. -Move gui files into a directory under the gui directory. - The gui directory name you create is important, because the gui - rwd file is built in alpha order by directory name - - -There are two ways to add applets to the directories. - - Creating code - - -* Manually write code and gui files - - The files go into your code directory - the filenames for code do not matter - - The gui files go into your gui directory - The gui files need to be in order by name and end with .rwd - - - - If you need a config file that goes in the configuration directory - - internationalization and localization are helped by replacing the - gui files in the subdirectories under gui - - -== Documents + Click on "Show Month" tab + enter + Year: 2005 + Month: 1 + Click on show month + + It will display one month - - when you click on a document name, the document should pop up in a - browser window, or in another browser tab. - -To exit, press the x inside the browser window. - -== Languages - - - You can add tranlations in the lang subdirectory - You change the $lang constant in Tinker config file in the configuration directory - You can see one translation on the install applet tab, after you have installed and applet - + == Using over a Network To serve the application over your local LAN,change the last line in the init.rb file to something like: RwdTinker.file(RWDFile).serve(8080, "-r" ? ".rwduids" : nil) @@ -141,178 +111,72 @@ user2 = pass phrase Thus the file .rwduids might contain: erik = secret - + == Requirements: -RubyWebDialogs - I am using 0.1.2 - This package you downloaded should have a runtime version of - the needed rubywebdialog files +RubyWebDialogs - I am using 0.0.11 2004-3-9 Ruby I am using version 1.8.2 + I have tested this under Linux-Debian kernel 2.6.9 -= Operation: -The code files reside in the code directory and are combined before -the main Class is loaded +== PROBLEMS: +It is easy to type a date with a space after it. That will have a somewhat invisible space +in it. -The rwd files in gui are combined before the gui is activated +don't type in the extension .sch -Translated text reside in the lang directory - -== Installing: - -untar the file -tar zxvf rwdtinker-x.y.tar.gz -then cd to the directory -cd rwdshell-x.y -then start the init.rb program file -ruby init.rb -Then point your browser at http://localhost:7705 -or where it tells you. -Trouble shooting: - -If the program is not working, try looking at the ev subdirectory. That is where -the runtime of rubywebdialogs are. - -for long term installation, I would suggest putting most files in a lib directory -like /usr/lib/rwdshell -then make a writable directory the local directory for command files to be written -like ~/rwdshell - - Closing the browser doesn't terminate the application. You have to use the application's close-button And terminating the application doesn't terminate the application when running in network mode. You just log out. Don't use the back-button of the browser! Strange and unpredictable things may and will happen! -RubyWebDialogs is a platform independent graphical user interface for Ruby applications. It generates HTML and serves it with an internal HTTP server, so you can use your favorite web browser as the front end for your Ruby application. All this means, that it can be used on almost every platform, like Ruby itself. http://www.erikveen.dds.nl/rubywebdialogs/ -== Credits +== contacts + For more information see: + http://rwdapplications.rubyforge.org/wiki/wiki.pl -Thanks go to: -* Matz, for creating Ruby in the first place. -* Erik, for creating RubyWebDialogs. -* Charlotte, my wife for coming up for the name Tinker. + For more information about RubyWebDialogs see: + http://www.erikveen.dds.nl/rubywebdialogs/index.html -== License -rwdtinker is copyright (c) 2004 Steven Gibson. It is free software, and may be redistributed -under the terms of the GPL licence: +Steven Gibson +steven@superant.com -== Contact - For more information see: -http://rwdapplications.rubyforge.org/wiki/wiki.pl +== Changelog +version 0.92 + Added delete update files function in sync tab - -For more information about RubyWebDialogs see: -http://www.erikveen.dds.nl/rubywebdialogs/index.html - -Thanks, Steven Gibson - -== Changelog -version 1.44 - updated directory structure - refactored gui files +version 0.91 + updated for rwdtinker 1.44 - refactored gui files Changed gui directory names - more like Java package titles -version 1.43 - changed setup variables file for live changes - added editing and reloading of config file - added unzip filename to config file - -version 1.42 - update for live update system - update applets for live update - code file name cleanup - -version 1.41 - l10n work es,nl, jp - separated out languge.cnf - added zip applets refreshacpi, rwdcalc - -version 1.40 - removed extra lines from init.rb - fixed help second window - added some tranlations for Spanish - More work on l10n - -version 1.3 - refactored gui files to do easier i10n - removed lang directories under gui - added lang files under lang dir - removed redundant code files left from moving applet handling to back window - removed zipped applets not yet refactored - -version 1.24 - added internet usage instructions to HowTo_Tinker.txt - removed HowTo_Tinker.html - added panels for Helpabout - changed photo logo tab to only have embedded picture, no button - -version 1.23 - moving diagnostic tab and applet handling tabs to second window - added selection panel tab to choose secondary windows. - -version 1.21 - changing version on help screen to be button - added version window - added diagnostic tab - -version 1.2 - added gemspec for creating a rwdtinker.gem - added rdoc comments - changed order on remove applets tab - -version 1.1 - changed order of elements on install applet tab - Add more i81n ablility - added lang directorys for language hash files - added in test file using WATIR stands for "Web Application Testing In Ruby, - -version 1.0 - Improved name selection in zips and applet screens - added rubyslippers applet and rwdrefreshacpi applets as zips - version 0.9 - Fixed bug introduced in 0.8 - code files not sorted correctly - class end was not in correct location - updated RubyWebDialogs for people who do not have it installed - added rwdschedule applet as zip file - + added back window for sync tasks + added configuration viewing + added ftp file download for sync + added ftp file upload for sync + add update files and schedule sync compares + version 0.8 - changed location of code files - only directory of code files needs to be added to inf file - changed location of gui files - only directory of gui files needs to be added to inf file - Added constants in conf file for code location and gui location - removed all zips not yt updated to new directory layout - change loading of conf files to not need intermediate file - and favicon.ico - -version 0.7 - moved changelog to HowTo_Tinker.html - copied english gui text to the dirs I think we should translate to - update backup zip files to newest versions - upgraded the ev directory - for those who don't have RubyWebDialogs - -version 0.6 - updated version number - changed merge name to rwdtinker.rb - + updated for rwdtinker 1.42 - semi-live updates + +version 0.7 + updated for rwdtinker 1.4 + addition to documentation + +version 0.6 + updated for rwdtinker 1.3 + +version 0.5 + added edit commands to change event record + Rename event + Delete event + changed order of event list - descending = oldest at top + version 0.4 - added zip listing and installing - Linux only - -Version 0,3 - changed name to Tinker - -Version 0.2 - added some i18n directories for the gui files - -Version 0.1 - first public version released - includes document screen - Open Photo screen - included configuration directory - zips directories - installed directory - installed applet lister - +added configuration file with location of schedules directory +add date selection to view event tab +updated to version 1.0 of rwdtinker