Instructions for Building and Running the Development Code for Documents

This is a simple guide for setting up a hacking environment for the Documents application. Please feel free to add notes if you find an inaccuracy or run into a problem. This is meant to be a beginners' guide. You may not need to use all of the information, but I prefer to spell things out so you can refer to it if you get stuck at any point.

including Webkit (takes a few hours longer, milage varies):$ jhbuild build gnome-documentsto build without Webkit:$ jhbuild build --skip=webkit gnome-documentsIn my experience, most errors are caused by missing development packages. if you run into an error, look at the terminal output. after "checking for" you may find that you are missing a required package. You can check for the package using yum info packageName. if you have the package installed check to see if you need the development package by running yum info packageName-devel. Install the required packages.

The miners are installed in /opt/gnome/share/dbus-1/services by JHBuild. Copy them to /usr/share/dbus-1/services:

If you can successfully run Documents but no documents are appearing, assuming you have documents in your local directories or have added the correct accounts (e.g. Google) to Online Accounts and set the toggle switch for Documents to "On":$ tracker-control --start

If the theming looks strange (e.g. there are no icons in the application), then you need to build gnome-themes-standard:$ jhbuild build gnome-themes-standard

Suggested Topics for Documentation

Search, selection mode and the various actions you can do inside it and the various controls you have available while previewing - both the actions available from the gear menu and the document navigation features we recently implemented in master (just keep in mind we have more work lined up for 3.8 on this part, so what you see in master might not be final yet).