[elpa] master 0f8007e 071/177: Simplify: index.org no longer repeats info in the README

[João Távora]

branch: master
commit 0f8007e67e869c63479eb531a997238cf813ac7e
Author: Joao Tavora <address@hidden>
Commit: Joao Tavora <address@hidden>

    Simplify: index.org no longer repeats info in the README
---
 doc/index.org |  118 +++++++++++----------------------------------------------
 1 files changed, 22 insertions(+), 96 deletions(-)

diff --git a/doc/index.org b/doc/index.org
index e7ac12d..f99b3f7 100644
--- a/doc/index.org
+++ b/doc/index.org
@@ -1,118 +1,44 @@
 #+SETUPFILE: org-setup.inc
 #+TITLE: Yet another snippet extension
 
-* Quick start
+The YASnippet documentation has been split into separate parts:
 
-  *YASnippet* is a template system for Emacs. It allows you to type an
-  abbreviation and automatically expand it into function templates. Bundled
-  language templates includes: C, C++, C#, Perl, Python, Ruby, SQL, LaTeX, 
HTML,
-  CSS and more. The snippet syntax is inspired from TextMate's syntax, you can
-  even [[#import-textmate][import most TextMate snippets]]
+0. 
[[https://github.com/capitaomorte/yasnippet/blob/master/README.mdown][README]]
 
-  YASnippet is an original creation of [[http://pluskid.lifegoo.org][pluskid]] 
who also wrote its predecessor
-  [[http://code.google.com/p/smart-snippet][smart-snippet]].
+   Contains an introduction, installation instructions and other important
+   notes.
 
-** Watch a demo
+1. [[file:snippet-organization.org][Organizing Snippets]]
 
-   On [[http://www.youtube.com/watch?v=ZCGmZK4V7Sg][youtube]].
+   Describes ways to organize your snippets in the hard disk.
 
-** Installation
+2. [[file:snippet-expansion.org][Expanding Snippets]]
 
-   Clone this repository somewhere
+   Describes how YASnippet chooses snippets for expansion at point.
 
-   #+begin_example
-   $ cd ~/.emacs.d/plugins
-   $ git clone https://github.com/capitaomorte/yasnippet
-   #+end_example
+   Maybe, you'll want some snippets to be expanded in a particular mode,
+   or only under certain conditions, or be prompted using =ido=, etc...
 
-   Add the following in your =.emacs= file:
+3. [[file:snippet-development.org][Writing Snippets]]
 
-   #+begin_src emacs-lisp :exports code
-   (add-to-list 'load-path
-                 "~/.emacs.d/plugins/yasnippet")
-   (require 'yasnippet)
-   (yas-global-mode 1)
-   #+end_src
+   Describes the YASnippet definition syntax, which is very close (but
+   not equivalent) to Textmate's. Includes a section about converting
+   TextMate snippets.
 
-   Add your own snippets to =~/.emacs.d/snippets= by placing files there or
-   invoking [[sym:yas-new-snippet][=yas-new-snippet=]].
+4. [[file:snippet-menu.org][The YASnippet menu]]
 
-** Import textmate snippets (rails example)
-   :PROPERTIES:
-   :CUSTOM_ID: import-textmate
-   :END:
+   Explains how to use the YASnippet menu to explore, learn and modify
+   snippets.
 
-   YASnippet lets you use TextMate bundles directly:
+5. [[file:faq.org][Frequently asked questions]]
 
-   #+begin_example
-   $ cd ~/.emacs.d/plugins
-   $ git clone https://github.com/capitaomorte/yasnippet
-   $ cd yasnippet
-   $ git submodule init
-   $ git submodule update
-   $ gem install plist trollop
-   $ rake convert_bundles             # will convert ruby, rails and html 
bundles from drnic
-   #+end_example
+   Answers to frequently asked questions.
 
-   Then, in your =.emacs= file
+6. [[file:snippet-reference.org][YASnippet Symbol Reference]]
 
-   #+begin_example
-   (add-to-list 'load-path
-                 "~/.emacs.d/plugins/yasnippet")
-   (require 'yasnippet)
-   (setq yas-snippet-dirs '("~/.emacs.d/snippets" 
"~/.emacs.d/extras/imported"))
-   (yas-global-mode 1)
-   #+end_example
+   An automatically generated listing of all YASnippet commands,
+   (customization) variables, and functions.
 
-   Open some rails file (model, app, etc) and start using the textmate
-   snippets. Consider that this is a work-in-progress and many 
snippets/commands
-   might not work. Patches welcome!
-
-** Contributing snippets
-
-   Please *do not ask me* to add snippets to the default collection under
-   =/snippets=. This collection is considered frozen. By customizing
-   [[sym:yas-snippet-dirs][=yas-snippet-dirs=]] you can point yasnippet to good
-   snippet collections out there.
-
-   The =extras/textmate-import.rb= tool can import many actual Textmate
-   snippets.  I'm focusing on developing it and the accompanying =yas-setup.el=
-   files that guide it with more difficult importations. The idea is to 
deprecate
-   =/snippets=  and replace it with =extras/imported=.
-
-** Documentation
-
-   The documentation has been split into separate parts:
-
-   1. [[file:snippet-organization.org][Organizing Snippets]]
-      Describes ways to organize your snippets in the hard disk.
-
-   2. [[file:snippet-expansion.org][Expanding Snippets]]
-      Describes how YASnippet chooses snippets for expansion at point.
-
-      Maybe, you'll want some snippets to be expanded in a particular mode,
-      or only under certain conditions, or be prompted using =ido=, etc...
-
-   3. [[file:snippet-development.org][Writing Snippets]]
-      Describes the YASnippet definition syntax, which is very close (but
-      not equivalent) to Textmate's. Includes a section about converting
-      TextMate snippets.
-
-   4. [[file:snippet-menu.org][The YASnippet menu]]
-      Explains how to use the YASnippet menu to explore, learn and modify
-      snippets.
-
-   5. [[file:snippet-reference.org][YASnippet Symbol Reference]]
-      An automatically generated listing of all YASnippet commands,
-      (customization) variables, and functions.
-
-** Bugs, discussion, contributions, etc
-
-   If you think you've found a bug, please report it on 
[[https://github.com/capitaomorte/yasnippet/issues][the GitHub issue tracker]]
-   (please **do not** submit new issues to the old 
[[http://code.google.com/p/yasnippet/issues/list][googlecode tracker]]).
-
-   If you run into problems using YASnippet, or have snippets to contribute,
-   post to the [[http://groups.google.com/group/smart-snippet][yasnippet 
forum]]. Thank you very much for using YASnippet!
 
 # Local Variables:
 # mode: org