tj64/outshine

need more detailed usage instructions

Closed this issue · 8 comments

tarsius commented

While I am very interested in this package I cannot figure out how to use it.

  1. Load outshine
  2. Open outshine
  3. M-x outline-minor-mode
  4. Move to ;; * some heading
  5. M-x outline-hide-sublevels

=> before first heading

What am I doing wrong?

tarsius commented

Also nothing is fontified. I cannot find a minor mode defined in outshine.el, so I was expecting that turning on outline-minor-mode would trigger that. You should mention how outshine hooks into outline-minor-mode.

tarsius commented 
;; See `outline-magic.el' (https://github.com/tj64/outline-magic) for detailled
;; instructions on usage of the additional outline functions introduced by
;; `outline-magic'.

I did but it didn't help. Also since outshine replaces outline-magic you should probably instead copy the documentation over and adapt it.

tj64 commented

I just modified the README for this repo, please follow the instructions there and it should work.

The steps are:

  1. Load outshine
  2. Add outline-hook-function to the outline-minor-mode-hook
  3. (maybe) add outline-minor-mode to e.g. emacs-lisp-mode-hook
  4. (maybe) set some global keys.
tarsius commented

Thanks a lot.

sshandilya commented

Sorry to resurrect this old thread ... But I keep getting this error when I follow the instructions:

Warning (initialization): An error occurred while loading `/Users/sshandilya/.emacs':

Invalid read syntax: #

 To ensure normal operation, you should investigate and remove the
 cause of the error in your initialization file.  Start Emacs with
 the `--debug-init' option to view a complete error backtrace.
tj64 commented

Hi,
with so little information its hard to tell ...

  1. did you try to start Emacs with --debug-init? Can you post relevant snippets from the Backtrace?
  2. or, when you deactivate outshine, does your .emacs load correctly (use M-x toggle-debug-on-error to get a Backtrace)?
  3. are there any accidental #'s in you .emacs (try M-x occur RET # RET in your .emacs buffer)

Some kind of Backtrace info would be necessary to identifiy the problem here.

sshandilya commented

This is the very end content of my .emacs

#+begin_src emacs-lisp
  (require 'outshine)
  (add-hook 'outline-minor-mode-hook 'outshine-hook-function)
#+end_src

#+begin_src emacs-lisp
  (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
#+end_src

#+begin_src emacs-lisp
 (add-hook 'LaTeX-mode-hook 'outline-minor-mode)
 (add-hook 'message-mode-hook 'outline-minor-mode)
#+end_src

#+begin_src emacs-lisp
 (defvar outline-minor-mode-prefix "\M-#")
#+end_src

outorg, outshine and navi-mode were installed via MELPA ...

(1). The --debug-init output:

Debugger entered--Lisp error: (invalid-read-syntax "#")
  eval-buffer(#<buffer  *load*> nil "/Users/sshandilya/.emacs" nil t)  ; Reading at buffer position 13376
  load-with-code-conversion("/Users/sshandilya/.emacs" "/Users/sshandilya/.emacs" t t)
  load("~/.emacs" t t)
  #[0 "�\205\262� \306=\203��\307�\310Q\202;� \311=\204��\307�\312Q\202;�\313\307\314\315#\203*�\316\202;�\313\307\314\317#\203:�\320\nB�\321\202;�\316\322�\323�\322\211#\210�\322=\203a�\324\325\326\307�\327Q!\"\323�\322\211#\210�\322=\203`���\210�\203\243�\330�!\331\232\203\243�\332�!\211\333P\334�!\203}�\211\202\210�\334�!\203\207��\202\210�\314\262��\203\241�\335��\"\203\237�\336\337��#\210\340\341!\210��\266�\f?\205\260�\314�\323\342\322\211#)\262�\207" [init-file-user system-type delayed-warnings-list user-init-file inhibit-default-init inhibit-startup-screen ms-dos "~" "/_emacs" windows-nt "/.emacs" directory-files nil "^\\.emacs\\(\\.elc?\\)?$" "~/.emacs" "^_emacs\\(\\.elc?\\)?$" (initialization "`_emacs' init file is deprecated, please use `.emacs'") "~/_emacs" t load expand-file-name "init" file-name-as-directory "/.emacs.d" file-name-extension "elc" file-name-sans-extension ".el" file-exists-p file-newer-than-file-p message "Warning: %s is newer than %s" sit-for 1 "default"] 7 "\n\n(fn)"]()
  command-line()
  normal-top-level()

(2). I get the same error if I have "#" anywhere in my .emacs, regardless of outshine being "required"/loaded or not.

(3). M-x occur RET # RET only finds the instances of "#" in my .emacs that are shown at the beginning of this reply.

tj64 commented

Hi, sorry for my delayed answers, I'm just overloaded right now and don't even get my own things done.

First of all,

(defvar outline-minor-mode-prefix "\M-#")

should appear in your init file before outline-mode is loaded, i.e. pretty much at the beginning, otherwise it won't work. Thats not an outshine issue, thats just the way to change the (terrible) default prefix of outline-minor-mode.

Otherwise I have a hard time to understand the backtrace (you are on Windows right? and compiled your .emacs file?). Buffer position 13376 is where the outline-minor-mode-prefix is defined?

Maybe try escaping the #, like "\M-#", although it should not be necessary. And get the .elc file out of the way if you have one, first make the uncompiled init-file work before you compile it. And move that declaration to the top of the init file.

HTH for now, let me know if not. Maybe you can post your problem on the Emacs help mailing list (with backtrace info), then you have a lot of experts ready to help you, in case these tips don't work out.