narrow-x

Extra functions for narrowing in Emacs
git clone https://git.jamzattack.xyz/narrow-x
Log | Files | Refs | LICENSE

README.org (2721B)


      1 #+title: Narrow-x
      2 #+author: Jamie Beardslee
      3 #+email: jdb@jamzattack.xyz
      4 
      5 This package provides a few extra convenience features for [[info:emacs#Narrowing][narrowing]].
      6 
      7 Mainly, it provides narrowing to the next or previous thing.
      8 Currently implemented:
      9 - page
     10 - defun
     11 - paragraph
     12 
     13 It also defines the missing [[help:narrow-to-paragraph][narrow-to-paragraph]].
     14 
     15 * Installation
     16 ** package.el
     17 Download narrow-x.el, and use =M-x package-install-file RET
     18 path/to/narrow-x.el=.
     19 
     20 ** straight.el
     21 Use the following recipe:
     22 
     23 #+begin_src emacs-lisp
     24   (narrow-x :type git
     25 	    :flavor melpa
     26 	    :repo "git://jamzattack.xyz/narrow-x")
     27 #+end_src
     28 
     29 ** Manual installation
     30 1. Download narrow-x.el
     31 2. Stick it in [[help:load-path][load-path]]
     32 3. Update autoloads
     33 4. (optionally) byte-compile it
     34 
     35 * Command index
     36 
     37 - *Function*: ([[help:narrow-to-next-page][narrow-to-next-page]] (&optional count))
     38 
     39   Narrow to the next page.
     40   Prefix arg COUNT is passed to [[help:forward-page][forward-page]], rather than
     41   [[help:narrow-to-page][narrow-to-page]].
     42 
     43 - *Function*: ([[help:narrow-to-prev-page][narrow-to-prev-page]] (&optional count))
     44 
     45   Narrow to the previous page.
     46   Negated prefix arg COUNT is passed to [[help:forward-page][forward-page]], rather than
     47   [[help:narrow-to-page][narrow-to-page]].
     48 
     49 - *Function*: ([[help:narrow-to-next-defun][narrow-to-next-defun]] (&optional count))
     50 
     51   Narrow to the next defun.
     52   Point will be moved to the beginning of the defun.  Prefix arg
     53   COUNT is passed to [[help:beginning-of-defun][beginning-of-defun]], rather than
     54   [[help:narrow-to-defun][narrow-to-defun]].
     55 
     56 - *Function*: ([[help:narrow-to-prev-defun][narrow-to-prev-defun]] (&optional count))
     57 
     58   Narrow to the previous defun.
     59   Point will be moved to the beginning of the defun.  Negated
     60   prefix arg COUNT is passed to [[help:beginning-of-defun][beginning-of-defun]], rather than
     61   [[help:narrow-to-defun][narrow-to-defun]].
     62 
     63 - *Function*: ([[help:narrow-to-paragraph][narrow-to-paragraph]] (&optional arg))
     64 
     65   Narrow to the next ARG paragraphs.
     66 
     67 - *Function*: ([[help:narrow-to-next-paragraph][narrow-to-next-paragraph]] (&optional count))
     68 
     69   Narrow to the next paragraph.
     70   Point will be moved to the beginning of the paragraph.  Prefix
     71   arg COUNT is passed to [[help:forward-paragraph][forward-paragraph]], rather than
     72   [[help:narrow-to-paragraph][narrow-to-paragraph]].
     73 
     74 - *Function*: ([[help:narrow-to-prev-paragraph][narrow-to-prev-paragraph]] (&optional count))
     75 
     76   Narrow to the previous paragraph.
     77   Point will be moved to the beginning of the paragraph.  Negated
     78   prefix arg COUNT is passed to [[help:forward-paragraph][forward-paragraph]], rather than
     79   [[help:narrow-to-paragraph][narrow-to-paragraph]].
     80 
     81 * License
     82 
     83 GPL3+