Method: Tree.menu

Defined in:
lib/xiki/tree.rb


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
# File 'lib/xiki/tree.rb', line 4

def self.menu
  "
  - api/
    > Get dir (or file) menu is nested under
    @ p Tree.file
    @ p Tree.file :require=>1   # Raise message if not nested under dir or file
    @ p Tree.file :require=>'file'   # Raise message if not nested under file
    @ p Tree.file :require=>'dir'   # Raise message if not nested under dir

    > Show siblings
    @ p Tree.siblings

    | Include all siblings (current line is usually ommited), just
    | siblings before, or just siblings after:
    @ p Tree.siblings :all=>1
    @ p Tree.siblings :after=>1
    @ p Tree.siblings :before=>1
    @ p Tree.siblings :string=>1   # Consecutive lines, quotes removed

    > Moving around
    @ Tree.to_parent   # Go to parent, regardless of blanks
    @ Tree.after_children   # Go after children of this element, crossing blank lines
    @ Tree.before_siblings   # Jumps to first sibling, crossing blank lines, but not double-blank lines
    @ Tree.after_siblings   # Go after last sibling, crossing blank lines, but not double-blank lines

    > All methods
    @ Tree.meths
  "
end