Difference between revisions of "Contributing to This Wiki"
Jump to navigation
Jump to search
(→Quickstart Tutorial: Move outline to separate page) |
|||
(17 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
A place to map out and plan the topics found in the wiki. | A place to map out and plan the topics found in the wiki. | ||
− | ==Outline | + | ==Manual Outline== |
− | |||
− | + | ===[[Ideology]]=== | |
− | + | ||
− | + | ===[[Quickstart Tutorial]]=== | |
− | |||
===Starting vifm=== | ===Starting vifm=== | ||
− | |||
# From some kind of menu (e.g. KDEMenu). | # From some kind of menu (e.g. KDEMenu). | ||
# From command-line | # From command-line | ||
Line 24: | Line 21: | ||
# From mail buffer in Vim to add an attachment | # From mail buffer in Vim to add an attachment | ||
− | === | + | ===[[Configuration model]]=== |
− | + | === [[Quiting Vifm]] === | |
− | |||
− | |||
===Modes general=== | ===Modes general=== | ||
− | |||
# What modes and submodes exist. | # What modes and submodes exist. | ||
# Transitions between modes and submodes. | # Transitions between modes and submodes. | ||
===Navigation=== | ===Navigation=== | ||
− | |||
# Navigation within view. | # Navigation within view. | ||
# Rearranging views. | # Rearranging views. | ||
# Marks. | # Marks. | ||
+ | #* State that marks remember both path to destination directory and a file in it. | ||
# Directory stack. | # Directory stack. | ||
===File searching=== | ===File searching=== | ||
− | |||
# / and ? | # / and ? | ||
# n and N | # n and N | ||
Line 50: | Line 43: | ||
===Manual file selection=== | ===Manual file selection=== | ||
− | |||
# 'hlsearch' and searching. | # 'hlsearch' and searching. | ||
# t command. | # t command. | ||
Line 57: | Line 49: | ||
===File auto selection=== | ===File auto selection=== | ||
− | |||
# Motions. | # Motions. | ||
# Selectors. | # Selectors. | ||
− | ===Command-line and alike modes=== | + | ===[[Command-line and alike modes]]=== |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===Command-line commands=== | ===Command-line commands=== | ||
− | |||
# General syntax overview. | # General syntax overview. | ||
#* :[range]command arg1 'arg2' "arg3" /arg4/ | #* :[range]command arg1 'arg2' "arg3" /arg4/ | ||
Line 91: | Line 71: | ||
===Controlling view=== | ===Controlling view=== | ||
− | |||
# Permanent file filtering. | # Permanent file filtering. | ||
# Real-time file filtering. | # Real-time file filtering. | ||
===Mappings=== | ===Mappings=== | ||
− | |||
# With remapping (:map). | # With remapping (:map). | ||
# Without remapping (:noremap). | # Without remapping (:noremap). | ||
Line 103: | Line 81: | ||
===Trash directories=== | ===Trash directories=== | ||
− | |||
# Overview, state incompatibility with Trash specification of FreeDesktop. | # Overview, state incompatibility with Trash specification of FreeDesktop. | ||
# Location ('trashdir' option). | # Location ('trashdir' option). | ||
Line 110: | Line 87: | ||
===Previewing files=== | ===Previewing files=== | ||
− | |||
# Exploring. | # Exploring. | ||
# Previewing. | # Previewing. | ||
− | ===Color schemes=== | + | ===[[Color schemes]]=== |
− | |||
− | |||
===Running files=== | ===Running files=== | ||
Line 123: | Line 97: | ||
===Writing scripts in vifmrc file=== | ===Writing scripts in vifmrc file=== | ||
+ | |||
+ | ===Index of Features=== | ||
+ | list all capabilities including synonyms of features to make things easier to search. | ||
+ | These should link to pages talking about the feature in detail. | ||
+ | Brainstorming how the index should look: | ||
+ | |||
+ | I think full syntax should be given in the command coloumn, with the command itself linking to a section that described all the fine details of the command in full | ||
+ | |||
+ | keywords will make actual ideas or concept easy to lookup | ||
+ | ps. It took me making this table that yank was a feature different than copy...... | ||
+ | |||
+ | {| class="wikitable" | ||
+ | ! Feature | ||
+ | ! Description | ||
+ | ! Command(s) | ||
+ | ! Default Mapping(s) | ||
+ | ! see also | ||
+ | ! keywords | ||
+ | |||
+ | |- | ||
+ | | copy | ||
+ | | copy to opposite pane | ||
+ | | :[range]co[py][!?][&] | ||
+ | | | ||
+ | | | ||
+ | | cp, yank, move | ||
+ | |- | ||
+ | | delete | ||
+ | | delete file and add to default(") register[[Trash|*]] | ||
+ | | :delete | ||
+ | | d | ||
+ | | | ||
+ | | rm, cut | ||
+ | |- | ||
+ | | Page up | ||
+ | | navigate up one page | ||
+ | | | ||
+ | | PageUp, Ctrl-B | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | | view | ||
+ | | view current file in the opposite pane | ||
+ | | :vie[w][!] | ||
+ | | | ||
+ | | | ||
+ | | preview, less | ||
+ | |- | ||
+ | | yank | ||
+ | | add file to the default(") register | ||
+ | | :[range]y[ank] [reg] [count] | ||
+ | | y | ||
+ | | copy | ||
+ | | cp | ||
+ | |} | ||
+ | |||
+ | ==Other Pages== | ||
+ | |||
+ | ===Users coming from mc=== | ||
+ | |||
+ | ===Differences from vim=== | ||
+ | |||
+ | ===Wiki Style Guidelines=== | ||
+ | *Vifm vs vifm | ||
+ | *filemanager not Filebrowser | ||
+ | *style for represnting code in a file (might want to snag the template used at [https://wiki.archlinux.org/index.php/Vim#Installation arch wiki]) | ||
+ | *commandline/shell/CLI/TUI | ||
+ | *categories | ||
+ | |||
+ | ===Table to Compare Modes=== |
Revision as of 20:03, 20 September 2014
A place to map out and plan the topics found in the wiki.
Manual Outline
Ideology
Quickstart Tutorial
Starting vifm
- From some kind of menu (e.g. KDEMenu).
- From command-line
- Where it starts (previous directories/current directory/any other directory)
- Start by specifying name of a file rather than directory name
- Specify path to fuse mount and path inside of it
- From any buffer in Vim
- Replace file in current buffer
- Edit in tab
- Edit in horizontal split
- Edit in vertical split
- Diff with file
- From mail buffer in Vim to add an attachment
Configuration model
Quiting Vifm
Modes general
- What modes and submodes exist.
- Transitions between modes and submodes.
- Navigation within view.
- Rearranging views.
- Marks.
- State that marks remember both path to destination directory and a file in it.
- Directory stack.
File searching
- / and ?
- n and N
- 'hlsearch', 'incsearch', 'ignorecase', 'smartcase'
- Regular expressions
Manual file selection
- 'hlsearch' and searching.
- t command.
- Visual mode.
- cover all submodes
File auto selection
- Motions.
- Selectors.
Command-line and alike modes
Command-line commands
- General syntax overview.
- :[range]command arg1 'arg2' "arg3" /arg4/
- Comments.
- Several commands separated by a bar ("|").
- :!! command.
- Ranges.
- Macros.
- User-defined commands.
- External commands.
- Local commands (":do something").
- Background commands.
- Commands that accept expressions.
- Backgrounding commands.
- Cancelling commands.
Controlling view
- Permanent file filtering.
- Real-time file filtering.
Mappings
- With remapping (:map).
- Without remapping (:noremap).
- Angle-bracket notation.
- Displaying existing mappings.
Trash directories
- Overview, state incompatibility with Trash specification of FreeDesktop.
- Location ('trashdir' option).
- Related command-line commands (":lstrash", ":trashes").
- Related normal mode commands (p, P, d, D).
Previewing files
- Exploring.
- Previewing.
Color schemes
Running files
Combining with external scripts
Writing scripts in vifmrc file
Index of Features
list all capabilities including synonyms of features to make things easier to search. These should link to pages talking about the feature in detail. Brainstorming how the index should look:
I think full syntax should be given in the command coloumn, with the command itself linking to a section that described all the fine details of the command in full
keywords will make actual ideas or concept easy to lookup ps. It took me making this table that yank was a feature different than copy......
Feature | Description | Command(s) | Default Mapping(s) | see also | keywords |
---|---|---|---|---|---|
copy | copy to opposite pane | :[range]co[py][!?][&] | cp, yank, move | ||
delete | delete file and add to default(") register* | :delete | d | rm, cut | |
Page up | navigate up one page | PageUp, Ctrl-B | |||
view | view current file in the opposite pane | :vie[w][!] | preview, less | ||
yank | add file to the default(") register | :[range]y[ank] [reg] [count] | y | copy | cp |
Other Pages
Users coming from mc
Differences from vim
Wiki Style Guidelines
- Vifm vs vifm
- filemanager not Filebrowser
- style for represnting code in a file (might want to snag the template used at arch wiki)
- commandline/shell/CLI/TUI
- categories