1. Jason McBrayer
  2. emacs-bbcode

Commits

Jason McBrayer  committed f63bd30

Added readme file

  • Participants
  • Parent commits 3fda13c
  • Branches default

Comments (0)

Files changed (1)

File README.org

View file
+
+* bcode-mode.el --- Major mode to edit bbcode files in Emacs
+
+This should be trivial and self explanatory.  It is for editing
+bbcode, typically when emacs(client) is called as an external
+editor from a web browser. It provides font-locking and insertion
+commands for the most common bbcode tags.
+
+This is a simple derived mode, not based on xbbcode-mode.
+
+** Keybindings
+
+| key     | binding              |
+|---------+----------------------|
+| C-c C-b | bbcode-insert-bold   |
+| C-c TAB | bbcode-insert-italic |
+| C-c C-l | bbcode-insert-link   |
+| C-c RET | bbcode-insert-image  |
+| C-c C-q | bbcode-insert-quote  |
+
+** Installation
+
+Put bbcode-mode.el in your load-path.  Add the following to your .emacs:
+
+#+begin_src emacs-lisp
+  (require 'bbcode-mode)
+#+end_src
+
+Or, if you prefer not to load the file until needed, this:
+
+#+begin_src emacs-lisp
+  (autoload 'bbcode-mode "bbcode-mode" "BBCode editing mode." t)
+  (add-to-list 'auto-mode-alist '("\\.bbc\\(ode\\)?\\'" . bbcode-mode))
+#+end_src
+
+
+** Usage
+
+   In Firefox, install the [[https://addons.mozilla.org/en-US/firefox/addon/4125][It's All Text!]] extension, and set it up to
+   use emacsclient as your editor. When editing a bbcode textarea,
+   right-click on the edit button, and select "edit with a new
+   extension", select ".bbc" or ".bbcode".
+