Kiln » TortoiseHg » TortoiseHg
Clone URL:  
Pushed to one repository · View In Graph Contained in 0.8.2, 0.8.3, and 0.9

stable doc: hacking notes

Changeset de53495f0aa5…

Parent 3c665252aefc…

by Giampaolo Fadel

Changes to one file · Browse files at de53495f0aa5 Showing diff from parent 3c665252aefc Diff from another changeset...

Change 1 of 1 Show Entire File doc/​ReadMe.txt Stacked
 
20
21
22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@@ -20,3 +20,50 @@
 On Windows, if you have no make tool you can use build.bat. If HTML  compiler and miktex are installed you can directly generate chm  (build chm) and pdf (build pdf). + +Hacking the source +================== + +Please follow this rules when hacking the doc source files. + +- As suggested by Sphinx (see http://sphinx.pocoo.org/rest.html#sections) + use: + + ************* + Chapter title + ************* + + Section title + ============= + + Subsection title + ---------------- + + Subsubsection title + ^^^^^^^^^^^^^^^^^^^ + +- To indicate a key or a combination of keys use :kbd:, for example: + + :kbd:`Ctrl-A` + +- To indicate a label, button or anything that appears in user interfaces + use :guilabel:, for example: + + :guilabel:`Commit` + +- To indicate a menu choise use :menuselection: and -->, for example: + + :menuselection:`TortoiseHg... --> About` + +- To indicate a file use :file:, for example: + + :file:`.hg/hgrc` + +- To indicate a command to enter into command window use :command:, for example: + + :command:`hgtk log` + +- To indicate a text to enter into a text input field in the GUI use ``, for example: + + ``myproxy:8000`` +