Skip to content

Instantly share code, notes, and snippets.

@TheWaWaR

TheWaWaR/Emacs-info-info.md

Last active December 16, 2015 00:59
Show Gist options
  • Save TheWaWaR/5351660 to your computer and use it in GitHub Desktop.
Save TheWaWaR/5351660 to your computer and use it in GitHub Desktop.
Download ZIP
<Emacs Info Info> Document Reading Note
Raw
Emacs-info-info.md

Concepts

  • Node : A content section
  • Menu : List subnodes
  • Cross-Reference : Link to some node
  • Index : um...index.
  • Table of Contents : Show node hierarchy
  • History : Just like borwser page history
  • Recents : A list show recent visited nodes

Key maps

  • n, p, u, t : Move by node
    • [n]ext, [p]revious, [u]p, [t]op)
  • m : Go to some menu in current node
    • allow the use of abbreviations
  • f : Go to some cross-reference in current node
  • , : Move by menu or cross-reference in current node
  • T : Show current Info file's Table of Contents
  • L : Show all recent visited nodes
  • i, I : Search index in entire file
    • `I' will give a results list
  • M-n : Clone buffer as an independent one

Reading flow

Reading flow is concat by reading use cases.

Writign an Info file

[Steps]

  1. Write it
    • Contains: [Node, Menu, Cross-reference, ]
  2. Make tag table by M-x Info-tagify
  3. Check validate by M-x Info-validate
  4. Place this file in ?/info/
  5. Add a menu in ?/info/dir

Notes

  • In Info documents which describe programs should index [commands, options, key sequences] that the program provides.

Thoughts

  • I learnt that do not scroll the document line by line but page by page. Do like this may make me more focused.

[Meta information]

  • This file created at: [2013-04-09 18:08]
  • Task started at: [2013-04-09 15:23]
  • Task finished at: [2013-04-10 11:48]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment