Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 301 lines (221 sloc) 11.621 kb
45a9c7f @jgm Reformatted README using standard markdown.
authored
1 Gitit
2 =====
89725fd @jgm Initial commit.
authored
3
f8cd051 @jgm Updated README.
authored
4 Gitit is a wiki program written in Haskell. It uses [HAppS][] for the
d9c8cd8 @jgm Modified description slightly, mentioning darcs as well as git.
authored
5 web server and [pandoc][] for markup processing. Pages and uploaded
6 files are stored in a [git][] or [darcs][] repository and may be modified either
7 by using the VCS's command-line tools or through the wiki's web interface.
16f9dde @jgm Updated configuration section of README.
authored
8 By default, pandoc's extended version of markdown is used as a markup language,
9 but reStructuredText can also be used. Pages can be exported in a
10 number of different formats, including LaTeX, RTF, OpenOffice ODT, and
11 MediaWiki markup. Gitit can be configured to display TeX math (using
12 [jsMath][]) and highlighted source code (using [highlighting-kate][]).
89725fd @jgm Initial commit.
authored
13
14 [git]: http://git.or.cz
d9c8cd8 @jgm Modified description slightly, mentioning darcs as well as git.
authored
15 [darcs]: http://darcs.net
89725fd @jgm Initial commit.
authored
16 [pandoc]: http://johnmacfarlane.net/pandoc
17 [HAppS]: http://happs.org
f8cd051 @jgm Updated README.
authored
18 [jsMath]: http://www.math.union.edu/~dpvc/jsMath/
19 [highlighting-kate]: http://johnmacfarlane.net/highlighting-kate/
89725fd @jgm Initial commit.
authored
20
45a9c7f @jgm Reformatted README using standard markdown.
authored
21 Getting started
22 ===============
89725fd @jgm Initial commit.
authored
23
45a9c7f @jgm Reformatted README using standard markdown.
authored
24 Compiling and installing gitit
25 ------------------------------
89725fd @jgm Initial commit.
authored
26
45a9c7f @jgm Reformatted README using standard markdown.
authored
27 You'll need the [GHC][] compiler and the [cabal-install][] tool. GHC can
98adca8 @jgm Note the GHC 6.10 requirement in README.
authored
28 be downloaded [here][]. Note that, starting with release 0.5, GHC 6.10
29 or higher is required. For [cabal-install][] on *nix, follow the [quick
45a9c7f @jgm Reformatted README using standard markdown.
authored
30 install][] instructions.
89725fd @jgm Initial commit.
authored
31
32 [GHC]: http://www.haskell.org/ghc/
33 [here]: http://www.haskell.org/ghc/
34 [cabal-install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall
35 [quick install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall#Quick Installation on Unix
36 [pcre]: http://www.pcre.org/
37
38 If you want the syntax highlighting feature, you need to make sure
39 that pandoc is compiled with support for it. First, make sure your system
45a9c7f @jgm Reformatted README using standard markdown.
authored
40 has the [pcre][] library installed. Then:
89725fd @jgm Initial commit.
authored
41
a7c11fe @jgm Simplified installation instructions.
authored
42 cabal update
43 cabal install -fhighlighting pandoc gitit
89725fd @jgm Initial commit.
authored
44
a7c11fe @jgm Simplified installation instructions.
authored
45 If you don't care about highlighting support, you can just do:
89725fd @jgm Initial commit.
authored
46
47 cabal install gitit
48
a7c11fe @jgm Simplified installation instructions.
authored
49 These commands will install the latest released version of gitit.
89725fd @jgm Initial commit.
authored
50 To install a version of gitit checked out from the repository,
51 change to the gitit directory and type:
52
53 cabal install
54
55 The `cabal` tool will automatically install all of the required haskell
56 libraries. If all goes well, by the end of this process, the latest
57 release of gitit will be installed in your local `.cabal` directory. You
58 can check this by trying:
59
60 gitit --version
61
62 If that doesn't work, check to see that `gitit` is in your local
63 cabal-install executable directory (usually `~/.cabal/bin`). And make
64 sure `~/.cabal/bin` is in your system path.
65
45a9c7f @jgm Reformatted README using standard markdown.
authored
66 Running gitit
67 -------------
89725fd @jgm Initial commit.
authored
68
45a9c7f @jgm Reformatted README using standard markdown.
authored
69 To run gitit, you'll need [git][] in your system path. Check this by doing
89725fd @jgm Initial commit.
authored
70
71 git --version
72
73db5a1 @jgm Noted need for UTF-8 locale in README.
authored
73 You should also make sure that you are using a UTF-8 locale.
74 (To check this, type `locale`.)
75
89725fd @jgm Initial commit.
authored
76 Switch to the directory where you want to run gitit. This should be a directory
5c5c337 @jgm Updated README.
authored
77 where you have write access, since two directories, `static` and `wikidata`, and
f498fc6 @jgm Use HStringTemplate template for pages.
authored
78 two files, `gitit-users` and `template.html`, will be created here. To
79 start gitit, just type:
89725fd @jgm Initial commit.
authored
80
81 gitit
82
83 If all goes well, gitit will do the following:
84
85 1. Create a git repository, `wikidata`, and add a default front page.
86 2. Create a `static` directory containing the scripts and CSS used by gitit.
f498fc6 @jgm Use HStringTemplate template for pages.
authored
87 3. Create a `template.html` file containing an (HStringTemplate) template
88 for wiki pages.
89 4. Start a web server on port 5001.
89725fd @jgm Initial commit.
authored
90
857efad @jgm Removed <> from URL in README.markdown.
authored
91 Check that it worked: open a web browser and go to http://localhost:5001.
89725fd @jgm Initial commit.
authored
92
45a9c7f @jgm Reformatted README using standard markdown.
authored
93 Configuration options
94 ---------------------
89725fd @jgm Initial commit.
authored
95
96 You can set some configuration options when starting gitit, using the
97 option `-f [filename]`. A configuration file takes the following form:
98
99 Config {
16f9dde @jgm Updated configuration section of README.
authored
100 repository = Git "wikidata",
101 defaultPageType = Markdown,
4dc907c @jgm Added recaptcha fields to configuration file.
authored
102 userFile = "gitit-users",
103 templateFile = "template.html",
104 staticDir = "static",
105 tableOfContents = False,
106 maxUploadSize = 100000,
107 portNumber = 5001,
108 debugMode = True,
109 frontPage = "Front Page",
110 noEdit = ["Help", "Front Page"],
111 noDelete = ["Help", "Front Page"],
112 accessQuestion = Just ("Enter the access code (to request an access code, contact me@somewhere.org):", ["abcd"]),
113 useRecaptcha = False,
114 recaptchaPublicKey = "",
72c2cc0 @jgm Better handling of mime types.
authored
115 recaptchaPrivateKey = "",
16f9dde @jgm Updated configuration section of README.
authored
116 mimeTypesFile = "/etc/mime.types"
89725fd @jgm Initial commit.
authored
117 }
118
16f9dde @jgm Updated configuration section of README.
authored
119 - `repository` specifies the type and (relative) path of the repository
120 in which the wiki's pages will be stored. If it does not exist, gitit
121 will create it on startup. Supported repository types are `Git` and
122 `Darcs`.
123
124 - `defaultPageType` is the type of markup used to interpret pages in
125 the wiki. Two values are currently supported: `Markdown` and `RST`.
126 If `Markdown` is selected, [pandoc]'s syntax extensions (for footnotes,
127 delimited code blocks, etc.) will be enabled. Note that pandoc's
128 reStructuredText parser is not complete, so some pages may
129 not be rendered correctly if `RST` is selected.
5c5c337 @jgm Updated README.
authored
130
f498fc6 @jgm Use HStringTemplate template for pages.
authored
131 - `userFile` is a file containing user login information (with hashed
5c5c337 @jgm Updated README.
authored
132 passwords). If it does not exist, gitit will start with an empty list
f498fc6 @jgm Use HStringTemplate template for pages.
authored
133 of users. Gitit will write a new `userFile` on shutdown.
134
135 - `templateFile` is a file containing an HTML template for the wiki pages.
136 If it does not exist, gitit will create a default template. (For most
137 purposes, this can be used just as it is, but some users may wish to
138 customize the look of their wiki.) `templateFile` is an
139 `HStringTemplate` template.
5c5c337 @jgm Updated README.
authored
140
141 - `staticDir` is the (relative) path of a directory in which static content
142 (javascript, CSS, images) is stored. If it does not exist, gitit will
143 create it on startup.
144
145 - `tableOfContents` is either `False` or `True`. If it is `True`, a table
146 of contents (derived from the page's headers) will appear on each page.
147
148 - `maxUploadSize` (in bytes) sets a limit to the size of file uploads.
149
150 - `portNumber` is the number of the port on which the wiki will be served.
151
152 - `debugMode` is either `True` or `False`. If it is `True`, debug information
153 will be printed to the console when gitit is running.
154
155 - `frontPage` is the name of the page that is designated as the "front" or
156 "entrance" page of the wiki. Any page may be designated.
157
158 - `noEdit` is a list of pages that cannot be edited.
159
160 - `noDelete` is a list of pages that cannot be deleted.
161
162 - `accessQuestion` provides primitive access control. It is either `Nothing`,
163 in which case anyone will be allowed to create an account and edit wiki pages,
164 or `Just (question, [answer1, answer2, ...])`, where question is a prompt
165 that will be displayed when a user tries to create an account, and
166 `answer1, answer2, ...` are the valid responses. The user must provide a
167 valid response in order to create an account.
89725fd @jgm Initial commit.
authored
168
6e198d4 @jgm Small tweaks on reCAPTCHA documentation in README.
authored
169 - `useRecaptcha` is either `True` or `False`. It specifies whether to
170 use the [reCAPTCHA] service to provide captchas for user registration.
4dc907c @jgm Added recaptcha fields to configuration file.
authored
171
6e198d4 @jgm Small tweaks on reCAPTCHA documentation in README.
authored
172 - `recaptchaPublicKey` and `recaptchaPrivateKey` are
173 [reCAPTCHA] keys, which can be obtained free of charge at
174 <http://recaptcha.net/api/getkey>. The values of these fields are ignored
175 if `useRecaptcha` is set to `False`.
4dc907c @jgm Added recaptcha fields to configuration file.
authored
176
72c2cc0 @jgm Better handling of mime types.
authored
177 - `mimeTypesFile` is the path of a file containing mime type associations.
178 Each line of the file should contain a mime type, followed by some space,
179 followed by a space-separated list of file extensions that map to that mime
180 type. If the file is not found, some simple defaults will be used.
181
4dc907c @jgm Added recaptcha fields to configuration file.
authored
182 [reCAPTCHA]: http://recaptcha.net
183
45a9c7f @jgm Reformatted README using standard markdown.
authored
184 Configuring gitit
185 =================
186
187 The `static` directory
188 ----------------------
89725fd @jgm Initial commit.
authored
189
190 If there is no wiki page or uploaded file corresponding to a request, gitit
191 always looks last in the `static` directory. So, for example, a file
5c5c337 @jgm Updated README.
authored
192 `foo.jpg` in the `img` subdirectory of the `static` directory will be
193 accessible at the url `/img/foo.jpg`. Pandoc creates three subdirectories
194 of `static`, `css`, `img`, and `js`, which include the icons, stylesheets,
195 and javascripts it uses.
89725fd @jgm Initial commit.
authored
196
89e0a04 @jgm Added note about possibility of putting static inside repository.
authored
197 Note: if you set `staticDir` to be a subdirectory of `repositoryPath`,
198 and then add the files in the static directory to your repository, you
199 can ensure that others who clone your wiki repository get these files
200 as well. It will not be possible to modify these files using the web
201 interface, but they will be modifiable via git.
202
45a9c7f @jgm Reformatted README using standard markdown.
authored
203 Changing the theme
204 ------------------
89725fd @jgm Initial commit.
authored
205
5c5c337 @jgm Updated README.
authored
206 To change the look of the wiki, modify `screen.css` in `static/css`.
207 To change the look of printed pages, modify `print.css`.
f498fc6 @jgm Use HStringTemplate template for pages.
authored
208 The logo picture can be changed by copying a new PNG file to
209 `static/img/logo.png`. For more radical changes, one can modify
210 `template.html`.
89725fd @jgm Initial commit.
authored
211
45a9c7f @jgm Reformatted README using standard markdown.
authored
212 Adding support for math
213 -----------------------
89725fd @jgm Initial commit.
authored
214
45a9c7f @jgm Reformatted README using standard markdown.
authored
215 Gitit is designed to work with [jsMath][] to display LaTeX math in HTML.
216 Download `jsMath` and `jsMath Image Fonts` from the [jsMath download page][].
89725fd @jgm Initial commit.
authored
217 You'll have two `.zip` archives. Unzip them both in the
5c5c337 @jgm Updated README.
authored
218 `static/js` directory (a new subdirectory, `jsMath`, will be
89725fd @jgm Initial commit.
authored
219 created). You can test to see if math is working properly by clicking
220 "help" on the top navigation bar and looking for the math example
221 (the quadratic formula).
222
223 To write math on a wiki page, just enclose it in dollar signs, as in LaTeX:
224
225 Here is a formula: $\frac{1}{\sqrt{c^2}}$
226
227 You can write display math by enclosing it in double dollar signs:
228
229 $$\frac{1}{\sqrt{c^2}}$$
230
231 [jsMath download page]: http://sourceforge.net/project/showfiles.php?group_id=172663
232
45a9c7f @jgm Reformatted README using standard markdown.
authored
233 Highlighted source code
234 -----------------------
89725fd @jgm Initial commit.
authored
235
236 If gitit was compiled against a version of pandoc that has highlighting support
45a9c7f @jgm Reformatted README using standard markdown.
authored
237 (see above), you can get highlighted source code by using [delimited code blocks][]:
89725fd @jgm Initial commit.
authored
238
239 ~~~ {.haskell .numberLines}
240 qsort [] = []
241 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
242 qsort (filter (>= x) xs)
243 ~~~
244
245 To see what languages are available:
246
247 pandoc -v
248
249 [delimited code blocks]: http://johnmacfarlane.net/pandoc/README.html#delimited-code-blocks
250
45a9c7f @jgm Reformatted README using standard markdown.
authored
251 Accessing the wiki via git
252 ==========================
89725fd @jgm Initial commit.
authored
253
254 All the pages and uploaded files are stored in a git repository. By default, this
255 lives in the `wikidata` directory (though this can be changed through configuration
256 options). So you can interact with the wiki using git command line tools:
257
258 git clone ssh://my.server.edu/path/of/wiki/wikidata
259 cd wikidata
260 vim Front\ Page.page # edit the page
261 git commit -m "Added message about wiki etiquette" Front\ Page.page
262 git push
263
264 If you now look at the Front Page on the wiki, you should see your changes
265 reflected there. Note that the pages all have the extension `.page`.
266
5c5c337 @jgm Updated README.
authored
267 Wiki links and formatting
268 =========================
269
270 For instructions on editing pages and creating links, see the "Help" page.
271
c118faa @jgm Instructions on making wikilinks in mardkown and rst.
authored
272 Gitit interprets links with empty URLs as wikilinks. Thus, in markdown pages,
273 `[Front Page]()` creates an internal wikilink to the page `Front Page`.
274 In reStructuredText pages, `` `Front Page <>`_ `` has the same effect.
275
a3c27c8 @jgm Added note in README about using UTF-8.
authored
276 Character encodings
277 ===================
278
279 Gitit assumes that the page files (stored in the git repository) are
ebbec6f @jgm Added UTF-8 support.
authored
280 encoded as UTF-8. Even page names may be UTF-8 if the file system supports
281 this. You should use a UTF-8 locale when running gitit.
a3c27c8 @jgm Added note in README about using UTF-8.
authored
282
45a9c7f @jgm Reformatted README using standard markdown.
authored
283 Reporting bugs
284 ==============
89725fd @jgm Initial commit.
authored
285
a49ba22 @jgm Added link to bug tracker on googlecode.
authored
286 Bugs may be reported (and feature requests filed) at
287 <http://code.google.com/p/gitit/issues/list>.
89725fd @jgm Initial commit.
authored
288
45a9c7f @jgm Reformatted README using standard markdown.
authored
289 Acknowledgements
290 ================
89725fd @jgm Initial commit.
authored
291
16f9dde @jgm Updated configuration section of README.
authored
292 Gwern Brandwen helped to optimize Gitit. Simon Michael contributed the patch for
293 RST support.
294
5c5c337 @jgm Updated README.
authored
295 The visual layout is shamelessly borrowed from Wikipedia.
89725fd @jgm Initial commit.
authored
296
5c5c337 @jgm Updated README.
authored
297 The stylesheets are influenced by Wikipedia's stylesheets and by the
298 bluetrip CSS framework (see BLUETRIP-LICENSE). Some of the icons in
299 `img/icons` come from bluetrip as well.
300
Something went wrong with that request. Please try again.