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
|
JClic: Authoring and playing system for educational activities
-----------------------------------------------------------------------------
This file contains information about the internal structure of JClic and
the organization of the source code.
For compilation instructions, see INSTALL.txt
-----------------------------------------------------------------------------
Directories
The source code of JClic is organized into the following directories:
* src
Contains the source code of the JClic modules. It is organized in several
sub-directories:
- core Main classes of JClic, including JClic Player
- author Code specific of the JClic author module
- report/reportServer The stand-alone JClic reports server
- report/webApp The J2EE application release of the reports server
- report/reportServlets Code common to both versions of the reports server
* extensions
Contains the code of several libraries and external tools needed to
run JClic:
- dbconn Implementation of three types of JDBC connections, used
by JClic reports: single, pooled and JNDI-defined.
- soundspi Classes used to play audio compressed in MP3 and OGG formats.
Code from four external projects are used:
** JLayer (http://www.javazoom.net/javalayer/javalayer.html)
** JOrbis (http://www.jcraft.com/jorbis/)
** MP3SPI (http://www.javazoom.net/mp3spi/mp3spi.html)
** Tritonus (http://www.tritonus.org/)
- xml Classes used to write, read and parse XML files:
** JDom (http://www.jdom.org) without XPath features.
** CustomJDom - Special XML outputter
- img Libraries for graphics processing
** image4j (http://image4j.sourceforge.net)
- json The JSON-java library
** json (http://json.org)
* lib
External libraries needed to compile JClic:
- jmf-api Java Media Framework API empty implementation, to be used only at compile time.
(http://java.sun.com/products/java-media/jmf/)
- qtjava-api QuickTime for Java empty implementation, to be used only at compile time.
(http://developer.apple.com/quicktime/qtjava/)
- servlet-api Needed to compile the J2EE version of JClic reports. Empty implementation, to be
used only at compile time. (http://java.sun.com/products/servlet/reference/api)
* deploy
Contains the "applicaton.xml" file, used in the J2EE web application of
JClic reports
* dist
This is the directory where the JAR files obtained as result of the build
process are stored. It contains also some scripts, icons and JNLP (Java
Network Launching Protocol) files.
* instal
This directory contains a script that generates the Windows installer of
JClic using the Nullsoft Scriptable Install System
(http://nsis.sourceforge.net). It contains also an Ant script that launches
NSIS and creates a ZIP with all the files needed to run JClic in any
Java-enabled system.
* i18n
Contains utilities used to translate JClic into different languages.
JClic uses Launchpad (https://translations.launchpad.net/jclic) as a translation platform.
* keystore
This folder contains a key store with a test certificate, that can be used
to sign the JAR files for test purposes. Please use your own certificate
if you plan to distribute your own versions of the program.
* xml
XML Schema (XSD) and Document Type Definitions (DTD) corresponding to the
documents used by JClic to store skins and projects.
-----------------------------------------------------------------------------
Edit instructions:
JClic was made using NetBeans, currently version 8.2
You can download this IDE from:
https://netbeans.org/downloads/
Build the extensions by launching "ant" from the "extensions" directory.
This will also make a copy of the generated JAR files into the "lib" directory:
> cd extensions
> ant
Launch NetBeans and open the project located in the "nbeans" folder.
The three last source folders, marked with an asterisk, contain fake (empty) skeletons
of "Java Media Framework", "QuickTime for Java" and the Servlet API. This is because
JMF and QuickTime are non-free software, and the servlet API is available only with
the full package of J2EE (not really needed for JClic).
To test the real behavior of JMF and QTJava you must obtain valid implementations
of the files "jmf.jar" and "QTJava61.zip" (see the URLs indicated above) and replace
its 'skeleton' source folder with a reference to a valid file in the "Libraries" folder
of the netBeans project.
To test the WebApp, you must replace the 'servlet-api/src' folder with a reference to a
fully implemented J2EE library (available in the stock of Netbeans libraries)
The main JClic classes are organized into the following Java packages:
/ Main classes (JClicApplet, JClicPlayer,
JClicInstaller, JClicAuthor and ReportServer)
/edu/xtec/jclic Main JClic core classes and interfaces
/edu/xtec/jclic/activities The JClic activities. Each group of similar
activities has its own package: associations,
memory, panels, puzzles, text and textGrid
/edu/xtec/jclic/automation The classes that provide automatic contents to
activities. One package is included here: "arith",
for automatic mental arithmetics.
/edu/xtec/jclic/bags Classes dealing with collections of objects like
activities, media, and sequence elements.
/edu/xtec/jclic/boxes Graphic and multimedia elements: cells, counters,
grids, buttons...
/edu/xtec/jclic/clic3 Classes used to import Clic 3.0 activities
/edu/xtec/jclic/edit Base for "editors", special classes used to
modify complex objects.
/edu/xtec/jclic/fileSystem Filesystems are objects used to read and write to
files under different protocols and formats.
/edu/xtec/jclic/media Classes that deal with sound, video...
/edu/xtec/jclic/misc Miscellaneous utilities specific to JClic
/edu/xtec/jclic/project Components of the JClic project structure
/edu/xtec/jclic/report Activity results reporting system
/edu/xtec/jclic/shapers Classes that deal with cell and grid shapes
/edu/xtec/jclic/skins Support to JClic visual aspects
/edu/xtec/jclic/beans Visual controls used in JClic Author.
/edu/xtec/resources Different sub-packages containing messages, icons,
graphics, sounds, etc.
/edu/xtec/util Utility classes not specific to JClic
|