Zekr Quran Study Application Developer

Expert assistant for the Zekr open-source Quran study application built with Java, SWT, Apache Lucene, and Velocity templates.

What This Skill Does

This skill provides comprehensive guidance for developing and maintaining Zekr, a cross-platform Quran study application. It understands the architecture, build system, resource structure, and all subsystems including search, audio playback, internationalization, bookmarking, and theming.

Instructions

1. Understand the Project Structure

When working with Zekr code:

2. Build System (Apache Ant)

Use these Ant commands for building:

```bash

Full build (extract source, compile, create JAR)

ant dist

Compile only

ant compile

Generate documentation

ant javadoc

Run the application

ant run

Clean build artifacts

ant clean

```

**Build Process Flow**:

1. Extract source from `dist/zekr-src.jar` to `build/src/`

2. Compile Java source to `build/classes/`

3. Copy `.properties` files as resources

4. Create final JAR at `dist/zekr.jar`

3. Running the Application

**Linux/Unix**:

```bash

./zekr.sh

```

**Direct Java Execution**:

```bash

java -Xms20m -Xmx128m -cp "lib/*:dist/zekr.jar" net.sf.zekr.ZekrMain

```

**JVM Requirements**:

4. Key Architecture Components

**GUI Framework (SWT)**:

**Template Engine (Velocity 1.6.2)**:

**Search Engine (Lucene 3.0.0)**:

**Audio Playback**:

**Internationalization**:

5. Configuration Files

**`res/config/config.properties`** - Main runtime settings:

**`res/config/resource-path.properties`** - Dynamic path resolution:

**`res/config/search-info.properties`** - Search engine settings:

**`res/config/shortcut.xml`** - Keyboard shortcuts with RTL support

**`res/config/lib/logger.properties`** - Log4j configuration:

6. Package Structure Reference

7. Extensibility Points

**Add New Reciter**:

**Create New Theme**:

**Add Language Pack**:

**Add Translation**:

**Customize Search**:

8. Development Best Practices

9. Debugging and Logging

10. Resource Management

**Text Resources**:

**UI Resources**:

**Embedded HTTP Server**:

Examples

**Building after code changes**:

```bash

ant clean

ant dist

ant run

```

**Adding a new reciter** (create `res/audio/new-reciter.properties`):

```properties

name=New Reciter Name

bitrate=64

url=http://example.com/quran/%1$03d%2$03d.mp3

```

**Testing with custom heap size**:

```bash

java -Xms30m -Xmx256m -cp "lib/*:dist/zekr.jar" net.sf.zekr.ZekrMain

```

Important Notes