View source

{|align=right
  |__TOC__
  |}

<!--
The next Open Siddur Live Chat will take place on '''Sunday, July 25th''' at 1:00PM EDT/10:00AM PDT/7:00PM Israel Time. For information, and to add to the agenda, please look at the [[IRC|conference page]].

This chat will focus on non-tech issues and should be suitable for all non-conding contributors to take part.

The chat will take place in the #opensiddur channel on irc://irc.freenode.net . (If you have an irc client, e.g. chatzilla, you can click [irc://irc.freenode.net/opensiddur here].)

If you do not have an IRC client, you can use the [http://webchat.freenode.net/?randomnick=1&channels=opensiddur&prompt=1 web based client]. 
-->
<div style="border: 1px solid rgb(255, 165, 0); background-color: rgb(255, 165, 0); margin: 10px;padding: 0.2em 0.4em;">
Logs are now posted for the [[IRC|Open Siddur Live Chats]] that took place on Sunday July 11th and July 25th, 2010. 
</div>
<!--
<div style="border: 1px solid rgb(163, 191, 177); background-color: rgb(206, 242, 224); margin: 10px;padding: 0.2em 0.4em;">Looking for the jewishliturgy-discuss mailing list?  It has moved!  See [[Mailing lists|our new mailing lists]].</div>

<div style="border: 1px solid rgb(163, 191, 177); background-color: rgb(206, 242, 224); margin: 10px;padding: 0.2em 0.4em;">Have a look at our early [[Demos]].</div>
-->
Welcome to the '''Open Siddur Project Development Wiki'''.

As part of our mission, the '''Open Siddur Project''' aims to produce a [http://www.gnu.org/philosophy/free-sw.html free software], web-based toolkit for users to prepare ''siddurim'' and other high quality Jewish liturgical works (such as ''haggadot'' and ''bentchers'') to be printed out, shared online, or accessed via e-readers. In a general sense, the application we're developing might be called a collaborative publishing platform: collaborative like a wiki but designed with the ultimate goal of generating print media. (Unlike a wiki, individual users are given the choice of which material that they'd like to share that they've modified or authored.) Online, the platform will provide a space for individual users to select from, author, and share all the components of a siddur including prayers, translations, commentaries, art, and layout templates for incorporation in new, custom designed ''siddurim''. Alternately, the platform could be used as a novel educational tool for the study of Jewish liturgy.

Our [http://opensiddur.net/about/ mission] encompasses the values of pluralism (acceptance for the diversity of Jewish cultural expression), historical awareness (the text of the ''siddur'' is an aggregate of thousands of years of creatively inspired works), and individual freedom (empowering individuals to design their own tools for developing their spiritual practice).

[[Image:Open_Siddur_Project_Application_Overview.jpg|300px|thumb|A flowchart illustrating the overall design of the Open Siddur Project's web application within the broader objective of creating a more vital and creatively vibrant Jewish culture.]]
Broadly, the work involved with creating our web application is divided in two parts:

'''Content gathering and preparation'''
:* [[scanning]] books and facsimile editions of manuscripts in the Public Domain, 
:* [[transcription|transcribing]] the text of those works by manually typing them out
:* [[proofreading]] our transcriptions for accuracy, 
:* and [[Encoding tutorial|encoding]] them for our database of text.  
:* For works that are not yet in the Public Domain, the Open Siddur Project receives and encodes new, original material [[Submissions HOWTO|shared]] using [[Project:Copyright|standard free culture licenses]]. All encoded content is entered into our open source database, making it accessible through our web application and our API.

and '''Software development''', i.e., the design and coding of the following:
:* [[JLPTEI|specifications]] of the XML-based format in which we archive the project's texts, 
:* [[Architecture|transforms]] to convert the XML-encoded documents into print- or display-ready formats, 
:* the [http://www.exist-db.org eXist]-based native XML database that contains the data,
:* and the web-based [[Architecture|application infrastructure]] used by developers and end users for editing, retrieving and remixing the texts we provide. 

Besides these two great efforts, we also advocate for the adoption of free culture licenses for the sharing of Jewish cultural works. For more information on this, please check out our [http://opensiddur.org web page].

<!-- OLD VERSION:
The '''Jewish Liturgy Project''' project aims to produce a [http://www.gnu.org/philosophy/free-sw.html free software] toolkit for making high-quality custom Jewish liturgical books such as ''haggadot'', ''siddurim'', and ''bentchers'' that can be displayed on screen or printed to paper. The project's goals include producing a reliable source text, enabling personalization and customization of the text for local rites and customs and selective inclusion of multilingual translations, transliterations, instructions, notes, and commentaries.  

Creating a web application interface for accessing this toolkit is the mission of the '''Open Siddur Project'''. The goals of the project are to create a collaborative publishing platform built around a social network of individuals passionate about the siddur, some wanting to craft their own siddur, others wanting to use it as an educational tool, or for sharing prayers, translations, commentaries, art, and layout templates for new siddurim. The mission of the Open Siddur Project is further described in our [[Mission Statement]] and encompasses the values of pluralism (acceptance for the diversity of Jewish cultural expression), historical awareness (the text of the siddur is an aggregate of thousands of years of creatively inspired works), and individual freedom.
-->

===Development status===

Summary of current [[milestones|development status]]:
[[File:IODiagram.png|link=Architecture|thumb|300px|Summary diagram of data flow within the [[Architecture|project architecture]].]]
* Development is progressing on the backend technologies and on the end user interface.
* We are looking for volunteer developers.
* We are looking for accurate typists and careful proofreaders for both Hebrew and English texts.
* We have also made progress toward specific development [[milestones]].
* Our earliest proof-of-concept (a command line application) is available from [http://jewishliturgy.googlecode.com our subversion server].  Development on this proof of concept is now frozen.  All active development effort is directed toward the database/web application [[architecture]].

===Getting Started As A Contributor===

This is a free software/open source project.  It makes progress because volunteers put their time into making it work.

The first step to joining the project is joining the [http://groups.google.com/group/opensiddur-talk/ general mailing list] and/or the [http://groups.google.com/group/opensiddur-tech/ technical mailing list].  Let us know who you are and what you are interested in doing.

Tell us about yourself by [http://opensiddur.net/join-us/ filling out our survey].

Check out what we've done so far. A demonstration of our technology is now [[demos|available]].

Got any ideas for new ways to use the Open Siddur? Put them in the [[Brainstorm session]].

* The '''easiest way to get started immediately''' is as a '''text transcriber'''. To get started [[Transcription|click here]].

See the [[milestones]] page and the links from there to find out where active development is taking place now.  All software under development is available on [http://jewishliturgy.googlecode.com our subversion repository at Google code].  The trunk contains the most recent source code; it may be broken at any time.  For an introduction to coding for the project, see [[Intro to hacking]].

====How you can help us====
[[Image:Haggadda.page3.jpg|300px|thumb|A page from the ''proof of concept'' [[Special:FilePath/HaggadahPOC.pdf|Haggadah]], demonstrating support for automatic transliteration, and translations, side by side, color coded text, and footnote citations. One goal of the project is to allow fully customized prints from a single format.]]
<center>
{| class="wikitable" border="1" align="left"
! If you ... !! then ...
|-
| can type ... || help us [[Transcription|transcribe]] the 1917 JPS English Translation of the TaNaKh 
|-
| can [[Keyboard Setup/Hebrew|type in Hebrew with vowels]] (or want to learn how)... || help us [[Transcription|transcribe a historic Siddur]] 
|-
| write liturgy-related material ... || [[Submissions HOWTO|share it]] with a standard free culture license.
|-
| have access to public domain books and a high speed book scanner ... || try [[Transcription:Scanning Guidelines|scanning]] from our [[Scans|list of wanted books]]
|-
| code or document XML ... || proofread, debug, and/or provide examples for the [[JLPTEI]] XML specification, improve validators using [http://en.wikipedia.org/wiki/ODD_%28One_Document_Does_it_all%29 TEI ODD] or [http://www.schematron.com Schematron] 
|-
| code in any language ... || help us write one-time transformations to convert contributed material into [[JLPTEI]].
|-
| code in CSS ... || help us write rendering instructions for web browsers
|-
| code in Javascript ... || help us build our [[architecture|web application]]
|-
| code in Java ... || help us build the [[architecture|compiler application]] and/or choose and [[Target Survey|improve existing rendering engines]]
|-
| code in XSLT 2.0 ... || help us write [http://shell.jewishliturgy.org/doc/code/ transforms].
|-
| code in XQuery ... || help us write the toolkit API
|}
</center>

Progress on each of these is being tracked at the [[milestones]] page.  While the [[intro to hacking]] is under construction, the best way to get involved in coding is to [http://groups.google.com/group/opensiddur-tech contact us on the technical discussion list] or [http://opensiddur.net/join-us/ fill out our survey].

===Information===
* Follow our [http://opensiddur.net/ blog and RSS feed].
* [http://jewishliturgy.googlecode.com Project page on Google code] (includes instructions for subversion access).
* [[Environmental Scan]]: our research into related projects.
* [[Submissions HOWTO|Sharing your work]] with the Open Siddur Project
* [[OpenSiddurProject:Copyrights|Copyright and Licensing]]

===Social networking===
* Join and post to the [http://groups.google.com/group/opensiddur-talk/ general email discussion list]
* Join and post to the [http://groups.google.com/group/opensiddur-tech/ technical email discussion list]
* Follow the [http://www.twitter.com/opensiddur opensiddur feed on Twitter].
* Join our [http://www.facebook.com/group.php?gid=107922647745 Facebook group].

===Getting Help===
* Read the [[FAQ]].
* Join and email questions to either the [http://groups.google.com/group/opensiddur-talk/ general discussion list] or the [http://groups.google.com/group/opensiddur-tech/ technical discussion list]
* Talk to us in the IRC developer channel. No one is guaranteed to be there to answer questions. Please see [[IRC]] to join the channel.
* [http://opensiddur.net/contact Contact us] via email.

===Reporting Errors and Bugs===
Problems may be reported and discussed on the [http://groups.google.com/group/opensiddur-tech/ technical discussion list].  Bug reports should be submitted to the [http://code.google.com/p/jewishliturgy/issues issue tracker on Google code].