/doc/ReadMe.txt

Relevant Search: With Applications for Solr and Elasticsearch

For more in depth reading about search, ranking and generally everything you could ever want to know about how lucene, elasticsearch or solr work under the hood I highly suggest this book. Easily one of the most interesting technical books I have read in a long time. If you are tasked with solving search relevance problems even if not in Solr or Elasticsearch it should be your first reference. Amazon Affiliate Link

 1TortoiseHg Documentation
 2
 3To build this documentation you need sphinx installed.  On Ubuntu this
 4is the python-sphinx package.   On Windows your best bet is
 5easy_install.  To build without warnings, you need sphinx 0.6 or later.
 6
 7To build PDF files you need latex packages.  On Ubuntu this is
 8texlive-latex-extra and all of it's dependencies.  On Windows the best
 9choice is miktex.
10
11Once all of the prerequisites are in place, you can use the makefile to
12build targets: html htmlhelp latex
13
14Once latex is built, you have to cd into that output directory and run
15make all-pdf to build the actual PDF file.
16
17Once htmlhelp is built, you have to run the actual help compiler on a
18Windows machine.
19
20On Windows, if you have no make tool you can use build.bat. If HTML
21compiler and miktex are installed you can directly generate chm
22(build chm) and pdf (build pdf).
23
24Hacking the source
25==================
26
27Please follow this rules when hacking the doc source files.
28
29- As suggested by Sphinx (see http://sphinx.pocoo.org/rest.html#sections)
30  use:
31  
32  *************
33  Chapter title
34  *************
35
36  Section title
37  =============
38
39  Subsection title
40  ----------------
41
42  Subsubsection title
43  ^^^^^^^^^^^^^^^^^^^
44
45- To indicate a key or a combination of keys use :kbd:, for example:
46
47  :kbd:`Ctrl-A`
48  
49- To indicate a label, button or anything that appears in user interfaces 
50  use :guilabel:, for example:
51
52  :guilabel:`Commit`
53
54- To indicate a menu choise use :menuselection: and -->, for example:
55
56  :menuselection:`TortoiseHg... --> About`
57  
58- To indicate a file use :file:, for example:
59
60  :file:`.hg/hgrc`
61 
62- To indicate a command to enter into command window use :command:, for example:
63
64  :command:`hgtk log`
65
66- To indicate a text to enter into a text input field in the GUI use ``, for example:
67
68  ``myproxy:8000``
69