worship-agent / examples /README.md
DynamicPacific
Deploy worship program generator application to HF Space
7ca4566

A newer version of the Gradio SDK is available: 6.12.0

Upgrade

Example Files

This directory contains sample input files to help you understand the expected format for the Worship Program Generator.

📄 Files

1. sample_chinese_sermon.txt

Type: Pre-written Chinese sermon text Encoding: UTF-8 Use Case: Option A - Upload as Chinese sermon text

Content:

  • Complete sermon manuscript in Chinese
  • Includes: Title, Scripture reference, Introduction, Main points, Conclusion
  • Proper paragraph breaks and structure
  • Scripture references in Chinese format

How to Use:

  1. Upload this file as "Chinese Sermon Text"
  2. Upload a bulletin PDF
  3. Click "Generate Worship Program"

2. sample_slides.pdf (Not included - Create your own)

Type: Sermon slides presentation Format: PDF (text-based or image-based) Use Case: Option B - Generate narrative from slides

Expected Content:

  • Title slide with sermon title
  • Main point slides (bullet points or short text)
  • Scripture reference slides
  • Can be PowerPoint/Keynote exported as PDF

How to Create:

  1. Create a sermon presentation in PowerPoint/Keynote
  2. Export/Save as PDF
  3. Upload as "Sermon Slides PDF"

3. sample_bulletin.pdf (Not included - Create your own)

Type: Worship bulletin Format: PDF Use Case: Required for all workflows

Expected Content:

  • Worship date (preferably in filename: bulletin-2024-01-07.pdf)
  • Order of worship
  • Hymn numbers and titles
  • Scripture reading passages
  • Announcements
  • Any liturgical elements

Naming Convention:

  • Recommended: RCCA-worship-bulletin-YYYY-MM-DD.pdf
  • Or: bulletin-YYYY-MM-DD.pdf
  • Date will be auto-extracted from filename

📝 File Format Guidelines

Chinese Sermon Text (.txt)

[Sermon Title in Chinese]

经文:[Scripture Reference]

[Introduction paragraph]

一、[First Main Point]
[Content for first point]

二、[Second Main Point]
[Content for second point]

三、[Third Main Point]
[Content for third point]

[Conclusion]

Tips:

  • Use UTF-8 encoding
  • Include clear section markers (一、二、三 or I. II. III.)
  • Add paragraph breaks for readability
  • Include scripture references in Chinese format

Sermon Slides PDF

Recommended Structure:

Slide 1: Title
  信心的旅程
  Journey of Faith

Slide 2: Scripture
  创世记 12:1-9
  Genesis 12:1-9

Slide 3: Main Point 1
  • 神的呼召
  • God's Call
  • [Key points]

Slide 4: Main Point 2
  • 神的应许
  • God's Promise
  • [Key points]

Slide 5: Application
  • 实践的教导
  • Practical Teaching

Tips:

  • Keep text clear and readable
  • Use consistent formatting
  • Include both Chinese and English if bilingual
  • Avoid heavy graphics (focus on text content)

Worship Bulletin PDF

Recommended Sections:

主日崇拜程序
Sunday Worship Service

日期:2024年1月7日

序乐 Prelude
宣召 Call to Worship
祷告 Prayer
诗歌 Hymn #123
读经 Scripture Reading: 创世记 12:1-9
信息 Sermon: [Title]
回应诗歌 Response Hymn #456
奉献 Offering
祝福 Benediction

报告事项 Announcements
- [Announcement 1]
- [Announcement 2]

Tips:

  • Include date prominently
  • List hymns with numbers
  • Specify scripture passages
  • Keep format clean and structured

🧪 Testing the System

Quick Test Workflow

  1. Prepare Files:

    • Chinese sermon text OR sermon slides PDF
    • Worship bulletin PDF
  2. Upload:

    • Go to the Worship Program Generator interface
    • Upload your files
    • Enter or leave blank the worship date
  3. Generate:

    • Click "Generate Worship Program"
    • Wait 30-60 seconds
  4. Download:

    • Download both Markdown and DOCX versions
    • Review for accuracy
    • Edit as needed

⚠️ Common Issues

Encoding Errors

  • Problem: Chinese characters display incorrectly
  • Solution: Save text files as UTF-8 encoding

PDF Extraction Failures

  • Problem: Cannot extract text from PDF
  • Solution: Ensure PDF is not password-protected, try regenerating PDF with text layer

Missing Date

  • Problem: Date not auto-detected
  • Solution: Include date in filename or manually enter in the form

Translation Quality

  • Problem: Translation is awkward or inaccurate
  • Solution: Review and manually edit the output, especially theological terms

📧 Support

For issues or questions:

  1. Check the troubleshooting section in the main README
  2. Review these example formats
  3. Open an issue on GitHub with sample files (anonymized)

Note: The actual PDF files (sample_slides.pdf and sample_bulletin.pdf) are not included in this repository. Please create your own based on the guidelines above, or use your church's existing files.