summary refs log tree commit diff stats
path: root/doc/pydoc/ranger.gui.defaultui.html
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2010-03-12 01:17:56 +0100
committerhut <hut@lavabit.com>2010-03-12 01:17:56 +0100
commit02cf8f611f9b7d836b141bb1b54f7116fa331e68 (patch)
tree2e2007c73c0171e343ceaa6d422d6d9462214752 /doc/pydoc/ranger.gui.defaultui.html
parent936211c8913fe2ed9df9e97342e8ddf3b939c6bb (diff)
downloadranger-02cf8f611f9b7d836b141bb1b54f7116fa331e68.tar.gz
moved ranger.actions and ranger.commands
Diffstat (limited to 'doc/pydoc/ranger.gui.defaultui.html')
0 files changed, 0 insertions, 0 deletions
2010-02-15 21:57:21 +0100 added guidelines on code modification' href='/akspecs/ranger/commit/HACKING?h=v1.6.0&id=f8f6f7f94b3c0a1da2d8abb38cf23ca127dd28a4'>f8f6f7f9 ^
3ee05c16 ^
29028631 ^
1881922f ^
f8f6f7f9 ^
f8f6f7f9 ^

29028631 ^


3ee05c16 ^

f8f6f7f9 ^






29028631 ^
f8f6f7f9 ^









f8f6f7f9 ^






dade4742 ^


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95











                                                                          
                                                    






                                                                  
                      

                                                                       
                                                            

 













                                               















                                                            
                                    
                           
                        
 

                                                                      


                                                                              

                            






                                                                 
                                                                       









                                                                      






                 


                                                
Guidelines on Code Modification
===============================

Coding Style
------------

* Use syntax compatible to both python 2.6 and 3.1.
* Use docstrings with pydoc in mind
* Follow the style guide for python code:
    http://www.python.org/dev/peps/pep-0008/
* Although this guide suggests otherwise, tabs are used for indentation
    of code and docstrings.  In other documents (readme, etc), use spaces.
* Test the code with unit tests where it makes sense


Patches
-------

Send patches, created with "git format-patch", to the email adress

    romanz@lavabit.com

If you plan to do major changes, or many changes over time, I encourage
you to create a fork on GitHub, Gitorious or any other site.


Starting Points
---------------

Good places to read about ranger internals are:
ranger/core/actions.py
ranger/core/environment.py
ranger/fsobject/fsobject.py

About the UI:
ranger/gui/widgets/browsercolumn.py
ranger/gui/widgets/browserview.py
ranger/gui/defaultui.py


Common Changes
--------------

* Change which files are previewed in the auto preview:
In ranger/gui/widget/browsercolumn.py
the constant PREVIEW_BLACKLIST

* Adding options:
In ranger/defaults/options.py
add the default value, like: my_option = True
In ranger/shared/settings.py
add the name of your option to the constant ALLOWED_SETTINGS

The setting is now accessible at self.settings.my_option,
assuming <self> is a "SettingsAware" object.

* Changing commands, adding aliases:
ranger/defaults/commands.py
or ~/.ranger/commands.py

* Adding colorschemes:
Copy ranger/colorschemes/default.py to ranger/colorschemes/myscheme.py
and modify it according to your needs.  Alternatively, mimic the jungle
colorscheme.  It subclasses the default scheme and just modifies a few things.
In ranger/defaults/options.py (or ~/.ranger/options.py), change
    colorscheme = 'default'
to: colorscheme = 'myscheme'

* Change which files are considered to be "hidden":
In ranger/defaults/options.py
change the hidden_filter regular expression.

* Change the key map:
Modify ranger/defaults/keys.py.  This should be self-explanatory.
Check out ranger/core/actions.py for the most common actions, of course
you can also use your own functions.

* Change the file type => application associations:
In ranger/defaults/apps.py
modify the method app_default.
The variable "f" is a filesystem-object with attributes like mimetype,
extension, etc.  For a full list, check ranger/fsobject/fsobject.py

* Change the file extension => mime type associations:
Modify ranger/data/mime.types


Version Numbering
-----------------

X.Y.Z, where:

* X: Major version, milestone
* Y: Minor version, odd number => stable version
* Z: Revision