richdocuments/README.md

documents
=========

Documents app for ownCloud

An ownCloud app to work with office documents alone and/or collaboratively.

[![Build Status](https://travis-ci.org/owncloud/documents.svg?branch=master)](https://travis-ci.org/owncloud/documents)

### Known issues ###
**Problem**: Editor doesn't open. Spinner spins for ages.  
**Solution**: Try to disable gzip for Documents app by adding the following line to your .htaccess:  
`SetEnvIf Request_URI .*/apps/documents/ajax/.* no-gzip dont-vary`

**Problem**: Doc(x) support doesn't work  
**Solution**: Install at least  `libreoffice-common` and  `libreoffice-writer` packages for your distro.  
If you don't want to mess around with dependencies, you need simply install `unoconv` package. It will do the trick for you.

### How to add more fonts ###
+ Upload font files to **documents/css/fonts** directory
+ Edit **documents/css/fonts.css** adding `@font-face` rule for each uploaded file 

### CloudSuite upgrade ###
Similar to WebODF upgrade below, but easier:

        ./src/updateWebODF.sh prepare
        ./src/updateWebODF.sh copy

### WebODF upgrade ###
1. Build WebODF:


        ./src/updateWebODF.sh prepare
or


        git clone https://github.com/kogmbh/WebODF.git webodf
        mkdir build
        cd build
        cmake ../webodf
        make all webodf-debug.js-target build-wodocollabtexteditor

2. Refresh code and create a new branch:

        cd /path/to/documents
        git checkout master
        git pull --rebase
        git checkout -b new-branch

3. Run upgrade script:

        ./src/updateWebODF.sh copy
        ./src/updateWebODF.sh patch

4. Resolve confilcts in patches (if any). Commit changes.
5. Update patches in `/path/to/documents/src/patches` according to conflicts. Commit changes.
6. Test UI. Fix glitches by updating CSS. Commit changes.
7. Run locale extraction script:

        ./src/updateWebODF.sh

8. Commit changes
9. Push the branch for testing
10. You are done.