Merge branch 'master' of ssh://repo.or.cz/srv/git/sgc2
[sgc2.git] / README.txt
blobb2320a2096a334110e32b5a75a2dc708fb6c8be2
1 Praat Demo Framework
3 Introduction
5 The Praat Demo Framework suplies a set of Praat scripts and other files that
6 produce a fully functional interactive Demo Window for stand alone applications.
8 It implements button drawing and event loop, application and configuration 
9 screens, help functions, and automatically saving current settings between sessions. 
10 Already included are recording sounds, opening files, drawing waveforms and 
11 selecting intervals with zooming.
13 GUI design is stored independend of the script code in tab separated tables 
14 (Praat Table objects). Changing the GUI for existing functionality can be done
15 without touching the scripts. Adding functionality only requires the addition of
16 a single function associated to each button added.
18 The Framework is geared towards multiple language support. All user visible texts
19 are stored in language specific tables which will be loaded automatically when the
20 language is selected. On platforms where Praat supports the display of full 
21 Unicode character sets, these can be used. For example, a fully Chinese GUI is as
22 simple as a fully English GUI. New translations can be added locally without 
23 touching the scripts or recompiling the (binary) application.
25 Files
27 It has not been possible to completely separate application specific and general
28 script code into separate files. However, the intention has been to concentrate
29 all general code into the main script file (praatdemoframe.praat), and to delegate
30 most application specific code to the Initialise.praat script. The MainPage.praat and
31 Config.praat files contain both general and application specific code. Eg, all the
32 code handling button functionalities.
34 MainPage.praat
35         Controls the main application window
36         
37 Config.praat
38         Controls the configuration page
39         
40 CreateTables.praat
41         All the GUI and text tables from Data translated into a single Praat script.
42         Necessary for stand alone scripts
43         
44 Data
45         Directory with all the (language specific) text and GUI tables
46         
47 gpl-2.0.html
48 gpl-2.0.txt
49         GPL v2 license text. All code is licensed under the GPL version 2.0 or later.
50         Please refer to the license text for details
51         
52 Initialise.praat
53         The application specific general initialization script. Contains mostly 
54         application specific code and definitions
55         
56 makefile
57         Construct the final header file for stand alone applications containing the script
58         in C text form suitable to include in main_Praat.c
59         
60 praatdemoframe.praat
61         The main script to call. The command ">praat praatdemoframe.praat" will run the 
62         script as an application. Should be renamed after your application. Mainly
63         contains general, application independend scripts.
64         
65 praat_module
66         Directory with files for creating stand-alone applications
67         
68 README.txt
69         This text
70         
71 tables2scripts.praat
72         Praat script to create CreateTables.praat from the Tabels in the Data directory