diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..1c6f1d3 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,82 @@ +# The sheetui user documentation + +## Running sheetui + +`sheetui --help` will print out help for the command line tags. + +`sheetui path/to/file` will open the file as a spreadsheet. The file does not have to exist already. If it does not it will be created when you save the spreadsheet. + +## User Interface + +The sheetui user interface is loosely inspired by vim. It is a modal interface that is entirely keyboard driven. At nearly any time you can type `Alt-h` to get some context sensitive help. + +### Navigation Mode + +The interface will start out in navigation mode. You can navigate around the table and between the sheets using the following keybinds: + +**Cell Navigation** + +* `h`, ⬆️, and `TAB` will move one cell to the left. +* `l`, ➡️, and `Shift-Tab` will move one cell to the right. +* `j`, ⬇️, and `Enter` will move one cell down. +* `k`, ⬆️, and `Shift-Enter` will move one cell up. + +**Sheet Navigation** + +* `Ctrl-n` moves to the next sheet +* `Ctrl-p` moves to the prev sheet + +Sheet navigation moves loops around when it hits the end or beginning sheets. + +**Numeric prefixes** + +You can prefix each of the keybinds above with a numeric prefix to do them that many times. So `typing 123h` will move to the left 123 times. Hitting `Esc` will clear the numeric prefix if you want to cancel it. + +**Modifying the Sheet or Cells** + +* `e` or `i` will enter CellEdit mode for the current cell. +* `Ctrl-h` will shorten the width of the column you are on. +* `Ctrl-l` will lengthen the width of the column you are on. + +**Other Keybindings** + +* `Ctrl-s` will save the sheet. +* `q` will exit the application. +* `:` will enter CommandMode. + + + +### CellEdit Mode + +You enter CellEdit mode by hitting `e` or `i` while in navigation mode. Type what you want into the cell. + +Starting with: + +* `=` will treat what you type as a formula. +* `$` will treat it as us currency. + +Typing a number will treat the contents as a number. While typing non-numeric text will treat it as text content. + +For the most part this should work the same way you expect a spreadsheet to work. + +* `Enter` will update the cell contents. +* `Esc` will cancel editing the cell and leave it unedited. + + + +### Command Mode + +You enter command mode by typing `:` while in navigation mode. You can then type a command and hit `Enter` to execute it or `Esc` to cancel. + +The currently supported commands are: + +* `write [path]` save the current spreadsheet. If the path is provided it will save it to that path. If omitted it will save to the path you are currently editing. +* `insert-row [number]` Inserts a row into the sheet at your current row. If the number is provided then inserts that many rows. If omitted then just inserts one. +* `insert-column [number]` Just line `insert-row` but for columns. +* `rename-sheet [idx] ` rename a sheet. If the idx is provide then renames that sheet. If omitted then it renames the current sheet. +* `new-sheet [name]` Creates a new sheet. If the name is provided then uses that. If omitted then uses a default sheet name. +* `select-sheet ` Select a sheet by name. +* `edit ` Edit a new spreadsheet at the current path. +* `quit` Quits the application + + diff --git a/src/ui/mod.rs b/src/ui/mod.rs index cd7eaf6..3124b94 100644 --- a/src/ui/mod.rs +++ b/src/ui/mod.rs @@ -420,26 +420,6 @@ impl<'ws> Workspace<'ws> { Ok(()) })?; } - KeyCode::Char('r') if key.modifiers == KeyModifiers::CONTROL => { - self.run_with_prefix(|ws: &mut Workspace<'_>| -> Result<()> { - let (row_count, _) = ws.book.get_size()?; - ws.book.update_entry( - &Address { - row: row_count + 1, - col: 1, - }, - "", - )?; - let (row, _) = ws.book.get_size()?; - let mut loc = ws.book.location.clone(); - if loc.row < row as usize { - loc.row = row as usize; - ws.book.move_to(&loc)?; - } - ws.handle_movement_change(); - Ok(()) - })?; - } KeyCode::Char('q') => { return Ok(Some(ExitCode::SUCCESS)); }