README.html

<p
>The Online Linguistic Database (OLD) is software for creating web applications dedicated to multi-user, collaborative documention of natural (and usually endangered or understudied) languages. An OLD web application helps contributors to create a consistent, structured, and highly searchable web-based repository of language data. These data consist of textual representations of linguistic examples (words, morphemes, and sentences with analyses and annotations), associated and embedded media files, and exportable representations of texts (e.g., research papers, narratives, etc.)</p
><div id="features"
><h1
  >Features</h1
  ><ol
  ><li
    >Multi-user, concurrent read/write access to a server-side language database.</li
    ><li
    >Interlinear glossed text (IGT) representations of data with integrated feedback on lexical consistency or morphological analyses.</li
    ><li
    >Powerful searches over the data set.</li
    ><li
    >Authentication and authorization to control access to data.</li
    ><li
    >Export to LaTeX, CSV, and plain text.</li
    ><li
    >Media file support: many-to-many associations of audio, video, and/or image with content embedded in data representations.</li
    ><li
    >IGT text creation.</li
    ><li
    >Automatic orthography conversion.</li
    ><li
    >Inventory-based transcription input validation.</li
    ></ol
  ></div
><div id="versions"
><h1
  >Versions</h1
  ><p
  >This is the OLD v. 0.2.X. It is being used in nine language-specific OLD web applications (see www.onlinelinguisticdatabase.org) and is still being maintained. However, primary development has moved to the <a href="https://github.com/jrwdunham/old"
    >OLD v. 1.0</a
    >, which includes support for creating morphological parsers, provides improved search functionality, and implements a shift to a more modular and reusable architecture (i.e., a RESTful HTTP/JSON web service with a SPA GUI). The applications running on the OLD v. 0.2.X will be migrated to the OLD v. 1.0 in the near future.</p
  ></div
><div id="license"
><h1
  >License</h1
  ><p
  >The OLD 0.2.X is open source and is licensed under the <a href="https://gnu.org/licenses/gpl.html"
    >GNU GENERAL PUBLIC LICENSE Version 3</a
    >. (Note that the OLD 1.0 is also open source but is licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0.txt"
    >Apache 2.0</a
    >.)</p
  ></div
><div id="technologies"
><h1
  >Technologies</h1
  ><p
  >The OLD is written in Python, using the <a href="http://www.pylonsproject.org/projects/pylons-framework/about"
    >Pylons</a
    > web framework and an <a href="http://www.sqlalchemy.org/"
    >SQLAlchemy</a
    > abstraction over a MySQL database.</p
  ></div
><div id="get-install"
><h1
  >Get &amp; Install</h1
  ><p
  >When installing the OLD 0.2.X, it is recommended that you use an isolated Python environment using <a href="http://www.virtualenv.org/en/latest/virtualenv.html"
    >virtualenv</a
    >. (Note that the OLD 0.2.X has been tested with Python 2.5 and 2.6, but not 2.7. Depending on your system Python version, it may be necessary to install Python 2.5 or 2.6 using <a href="https://github.com/yyuu/pyenv"
    >pyenv</a
    > or <a href="https://github.com/utahta/pythonbrew"
    >pythonbrew</a
    >.) Once <code
    >virtualenv</code
    > is installed, issue the following commands to create the isolated environment and to make sure you are using its Python:</p
  ><pre
  ><code
    >virtualenv env
source env/bin/activate
</code
    ></pre
  ><div id="from-source"
  ><h2
    >From Source</h2
    ><p
    >To download the source code of the OLD v. 0.2.X, install its dependencies, and serve it locally with the default configuration, run:</p
    ><pre
    ><code
      >git clone https://github.com/jrwdunham/old-webapp.git
cd old-webapp
python setup.py develop
paster setup-app development.ini
paster serve --reload development.ini
</code
      ></pre
    ></div
  ><div id="from-pypi"
  ><h2
    >From PyPI</h2
    ><p
    >To install a stable release of the OLD 0.2.X from the <a href="https://pypi.python.org/pypi/onlinelinguisticdatabase/0.2.9"
      >Python Package Index</a
      >, use <code
      >easy_install</code
      > and run:</p
    ><pre
    ><code
      >easy_install &quot;OnlineLinguisticDatabase==0.2.9&quot;
</code
      ></pre
    ><p
    >or use <code
      >Pip</code
      > and run:</p
    ><pre
    ><code
      >pip install &quot;OnlineLinguisticDatabase==0.2.9&quot;
</code
      ></pre
    ><p
    >To create the config file, generate the default values, and serve the application:</p
    ><pre
    ><code
      >mkdir my_old_webapp
cd my_old_webapp
paster make-config onlinelinguisticdatabase production.ini
paster setup-app production.ini
paster serve production.ini
</code
      ></pre
    ></div
  ><div id="using-mysql"
  ><h2
    >Using MySQL</h2
    ><p
    >The default configuration file (<code
      >development.ini</code
      >) uses a local SQLite database named <code
      >development.db</code
      >, which is probably fine for exploring the system initially. However, a deployed OLD 0.2.X application should use MySQL.</p
    ><p
    >First login to MySQL using your root account and create a MySQL database and a user with sufficient privileges. Something like this (replacing <code
      >dbname</code
      >, <code
      >username</code
      >, and <code
      >password</code
      > with sensible values):</p
    ><pre
    ><code
      >mysql&gt; create database dbname default character set utf8;
mysql&gt; create user 'username'@'localhost' identified by 'password';
mysql&gt; grant select, insert, update, delete, create, drop on dbname.* to 'username'@'localhost';
mysql&gt; quit;
</code
      ></pre
    ><p
    >Then comment out the SQLite option in the OLD 0.2.X configuration file (i.e., <code
      >development.ini</code
      > or <code
      >production.ini</code
      >) and uncomment the two MySQL lines, changing values as appropriate:</p
    ><pre
    ><code
      >sqlalchemy.url = mysql://username:password@localhost:3306/dbname
sqlalchemy.pool_recycle = 3600
</code
      ></pre
    ><p
    >Now the system is set up to use MySQL. Run the <code
      >setup-app</code
      > command again to generate the default values in the MySQL db:</p
    ><pre
    ><code
      >paster setup-app production.ini
</code
      ></pre
    ><p
    >or:</p
    ><pre
    ><code
      >paster setup-app development.ini
</code
      ></pre
    ><p
    >(You can ignore the <code
      >data truncated</code
      > warnings. This is a known issue.)</p
    ><p
    >See <a href="http://pylonsbook.com/"
      >The Pylons Book</a
      > for further details on serving and configuring Pylons-based web applications.</p
    ></div
  ><div id="default-users"
  ><h2
    >Default Users</h2
    ><p
    >Running <code
      >paster setup-app</code
      > creates three users with the following usernames and passwords.</p
    ><ul
    ><li
      >username: <code
	>admin</code
	>, password: <code
	>admin</code
	></li
      ><li
      >username: <code
	>contributor</code
	>, password: <code
	>contributor</code
	></li
      ><li
      >username: <code
	>viewer</code
	>, password: <code
	>viewer</code
	></li
      ></ul
    ><p
    >Use the admin account to create a new administrator-level user and delete all of the default users before deploying an OLD application.</p
    ></div
  ><div id="common-issues"
  ><h2
    >Common Issues</h2
    ><p
    >Note that if you are running Debian or Ubuntu and get an error like <code
      >EnvironmentError: mysql_config not found</code
      > after running <code
      >python setup.py develop</code
      >, then you probably need to install <code
      >libmysqlclient-dev</code
      >:</p
    ><pre
    ><code
      >sudo apt-get install libmysqlclient-dev
</code
      ></pre
    ><p
    >If you get an error page when using the browser-based interface, re-saving the system settings should solve it. I.e., go to Settings &gt; System Settings &gt; Edit System Settings and click the &quot;Save Changes&quot; button.</p
    ></div
  ></div
>