Frequently Asked Questions

• I’m not technical enough to set up Giterary, but I like some of the features, and the price is right. What can I do?

  I was once tasked at work with installing up a homebrewed Linux distribution. As part of its install process, a single-user mode prompt would drop me into an install script. That script began with a note from the author that said, “I never promised you a rose garden…” (quoting the 1970 Joe South/Lynn Anderson country song “Rose Garden") and finished by threatening to smash my hard drive platters if I didn’t understand something. It succeeded at making me both feel incredibly alone and helpless in my task, as well as made me feel like I never wanted to ask the author for help. Which I think was the desired effect.

  I made this thing, and my only good measure of success is getting people to use it, or want to use it. I don’t offer a lot of promises (and I’m a terrible gardener), but I do want to be available to help people set this up as well as get it so that more people can set it up. As I develop this further, I intend to try to make it easier to get Giterary deployed to any operating system, anywhere, with its full features enabled (git repository synchronization, etc.). However, configuration and installation are hard things, even if you have an extremely small list of dependencies.

  Right now it’s easiest to install on Linux (as that is what I’ve been developing Giterary on). If you’re installing on Linux, there is a install.sh script will take you through collecting your various bits of configuration information, setting up your directory structures, permissions, usernames, passwords, and other fun things. See the INSTALL documentation referencing the install.sh script for more information. It requires being a little bit tech savvy, and a familiarity with Linux-y types of things, but nothing insurmountable.

• Markdown is okay, but I like X better. Do you support that?

  Probably? Is it text-based? Is it easy to edit from an HTML textarea tag? Well, there are certainly places to add such things, but there isn’t anything particularly fancy. For the programmers out there, it’s a PHP switch statement, that passes off handling to a function that is assumed to return valid HTML. However, a lot of work goes into making Markdown-specific editing possible (with the addition of annotations, the live Markdown preview, etc.)

• Editing with textareas is pretty lame. Why don’t you use ckeditor? Or something more modern, or Javascript-y, or HTML5 friendly?

  In the same way that text files are hard to screw up, so too are textareas. Every browser can render them, every person can use them. Not to disparage the writers of editors like ckeditor, or the users of Giterary, but sometimes it’s nice to have something familiar, even if it is sort of lame.

  There’s also that, in the event of complete Javascript failure (or you run NoScript), your browser should be able to render the textarea just fine, and also be able to preview and commit your changes without need for the client-side Javascript. I’m a fan of elegantly degrading web applications.

  That said, you have options:

  • Greasemonkey scripts let you do all sorts of interesting things to web sites. You could apply something like a Vim emulator on top of the editing window, or any strange, awesome thing you can think of to make the textarea more useful to you.
  • Browser plugins like provide similar modified editing and browsing experiences.
  • Or even better, clone your Giterary repository locally, edit using your favorite text editors, and synchronize whenever you see fit. Some of my favorite text editors:
    • Vim (or Emacs, if you’re into that sort of thing)
    • Notepad++
    • TextMate
    • SublimeText (haven’t used it personally, but the things I hear is that I should).

• I don’t understand why I would ever use partitioning. Why would I ever want to split up my document?

  Valid question. It’s more of a feature for people who, prior to writing in Giterary, or prior to sane document management practices, worked only in single, monolithic documents (see: one great big Word document, or something like that). A feature like that is useful because it lets you split up a larger work into smaller, more manageable chunks.

• Something broke, and my repository is messed up. Giterary isn’t helping at all. I don’t want to start over. Please help.

  More often than not, an external git client, graphical or otherwise, will be able to answer your git repository’s quandary better. At very worst, copying your working directory out, and cloning from your last known good repository state should be sufficient to not lose what is in your working directory.

• I put something in my repository that is, um, “sensitive.” As in, it needs to be gone. Really gone.

  It happens sometimes. Usually, performing a “hard reset” to a commit before the sensitive information was in the system is sufficient.

  git reset --HARD COMMIT_BEFORE_BAD_STUFF_HAPPENED
  

  But sometimes there are things you want to keep that happened after the sensitive information got into the system. In that case, you have to use git to “rewrite history.” For this, Github has a decent article on how to do just this.

• Is Giterary supported on X (X being my operating system or computing platform of choice)?

  PHP, being an interpreted language, does not require compilation, and therefore, is supported on any platform a PHP interpreter is available (version 5.3). However, you also need git to be able to run git, and a web server capable of serving PHP scripts, and your operating system needs to support the type of piping used by the proc_open function in PHP. But other than that, pretty platform agnostic, I’d think.

• I have a healthy degree of paranoia, does Giterary support file encryption?

  Not at the moment, but it’s an interesting and precarious feature. For instance: you could implement it such that you would have to enter an extra password in order to “unlock” a file for editing. However, unless said paranoid individual isn’t also paranoid about their network traffic, it’s possible that the submission of that password could be intercepted.

  So: it’s possible. An extra extension handler, plus perhaps a modified form element, and you’d be in business. But it certainly wouldn’t be perfect, and would play hell with Giterary’s diff mechanisms.

• What coding conventions were used in the application, if any, you talentless hack?

  You can read about some of the programming conventions, if you really want, but it’s mostly the technical grandstanding and pseudo-philosophical ravings of a madman.

• What license is Giterary released under?

  Giterary is licensed under the GNU Public License, version 3. License text is (should be) included in your distribution of Giterary.

• There already exist industry standard word processing and novel writing tools, cheaply available, reliable, and better documented than this. Giterary is destined to fail.

  TODO: Wow. No punches pulled.

• Does Giterary support X method of authentication? Y method of authorization? How can I give person A permissions to do this, but not person B? Can I shout the words “Active Directory” three times and be able to log in successfully?

  There is only so much I can do to predict what people will use Giterary for, or who the will want to be able to use Giterary. If you or your organization require complex rules to determine who can do what and where and when in Giterary, you might be looking for a Content Management System (such as Wordpress, Drupal, etc.), which solves this problem much more elegantly.

  That said, Giterary’s barrier to entry on creating new but only slightly different things for authentication and authorization is pretty low. If you can easily solve a problem with a single PHP class, then it’s pretty easy to wire up.

• What the heck is this gibberish you turned my passwords into?

  TODO: Password hashing, passfiles.