[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 4823f53 55/62: Added section for a basic setup
From: |
Ian Dunn |
Subject: |
[elpa] master 4823f53 55/62: Added section for a basic setup |
Date: |
Sat, 9 Dec 2017 14:34:06 -0500 (EST) |
branch: master
commit 4823f532473cde2f1b8f83efdfad5857c6eecb9a
Author: Ian Dunn <address@hidden>
Commit: Ian Dunn <address@hidden>
Added section for a basic setup
* paced.el (Basic Setup): New section
(Selective Dictionaries): Mention using `t' as a key.
---
paced.org | 19 ++++++++++++++++++-
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/paced.org b/paced.org
index 218f5fc..b34f179 100644
--- a/paced.org
+++ b/paced.org
@@ -112,6 +112,21 @@ After that, add the following to your init file (typically
.emacs):
(add-to-list 'load-path "/full/path/to/paced/")
(require 'paced)
#+END_SRC
+** Basic Setup
+:PROPERTIES:
+:DESCRIPTION: The simplest setup
+:END:
+
+Paced needn't have a lot of setup to run. In fact, the simplest setup is as
+follows:
+
+1. Create a new dictionary, "Default" (See [[dictionary_creation][Creating a
Dictionary]])
+2. Set paced-global-dict-enable-alist to ~((t . "Default"))~ (See
[[selective_dictionaries][Selective Dictionaries]])
+3. Run ~M-x global-paced-mode~
+4. To add a file to the dictionary, use ~M-x
paced-add-buffer-file-to-dictionary~
+
+This will create a default dictionary and populate it from buffers you specify.
+
* Dictionaries
:PROPERTIES:
:DESCRIPTION: Paced's bread and butter
@@ -119,6 +134,7 @@ After that, add the following to your init file (typically
.emacs):
** Creating a Dictionary
:PROPERTIES:
:DESCRIPTION: First steps
+:CUSTOM_ID: dictionary_creation
:END:
Now that you've got paced installed, it's time to create a new dictionary.
@@ -154,6 +170,7 @@ documented in the edit buffer.
** Selective Dictionaries
:PROPERTIES:
:DESCRIPTION: Enabling certain dictionaries under certain conditions
+:CUSTOM_ID: selective_dictionaries
:END:
Paced provides a mechanism called the "enable list", that allows a user to
@@ -169,7 +186,7 @@ The conditions are one of the following:
dictionary should be active in any mode derived from that mode.
- A symbol, in which case the named dictionary is active whenever the value of
- that symbol is non-nil.
+ that symbol is non-nil. This includes the symbol ~t~.
- A function symbol, in which case the function is called with no arguments to
determine if the given dictionary should be enabled. If the function returns
- [elpa] master 5674746 49/62: Added function to check if point is in a comment, (continued)
- [elpa] master 5674746 49/62: Added function to check if point is in a comment, Ian Dunn, 2017/12/09
- [elpa] master 56944b8 44/62: Added documentation section for working with EDE, Ian Dunn, 2017/12/09
- [elpa] master 895f479 41/62: Pushed info pages, Ian Dunn, 2017/12/09
- [elpa] master 223809e 61/62: Fixed elpaignore file, Ian Dunn, 2017/12/09
- [elpa] master 2e306c8 40/62: Improved Introduction, Ian Dunn, 2017/12/09
- [elpa] master 139a199 53/62: Added note about dictionary properties, Ian Dunn, 2017/12/09
- [elpa] master 1234c0c 54/62: Updated info pages, Ian Dunn, 2017/12/09
- [elpa] master a3a7eac 51/62: Added default dictionary settings for population, Ian Dunn, 2017/12/09
- [elpa] master 7535133 58/62: Updated copyright blocks in all files, Ian Dunn, 2017/12/09
- [elpa] master bfdb640 43/62: Updated pabbrev comparison, Ian Dunn, 2017/12/09
- [elpa] master 4823f53 55/62: Added section for a basic setup,
Ian Dunn <=
- [elpa] master 69b0058 32/62: Remove test dependency on dictionary file, Ian Dunn, 2017/12/09
- [elpa] master 534df41 57/62: Updated info pages, Ian Dunn, 2017/12/09
- [elpa] master b7dc61d 59/62: Removed bootstrap.sh, Ian Dunn, 2017/12/09
- [elpa] master b07d853 60/62: Added elpaignore file, Ian Dunn, 2017/12/09
- [elpa] master 5480e97 52/62: Removed obsolete method, Ian Dunn, 2017/12/09
- [elpa] master bc054b8 46/62: Updated info pages, Ian Dunn, 2017/12/09
- [elpa] master 82bd0da 23/62: Fixed various defmethod names to use paced-dictionary- prefix, Ian Dunn, 2017/12/09
- [elpa] master e834a04 47/62: Updated copyright strings in preparation for pushing to GNU ELPA, Ian Dunn, 2017/12/09
- [elpa] master aa2c021 11/62: Added info documentation for future inclusion in ELPA, Ian Dunn, 2017/12/09
- [elpa] master b35b6eb 01/62: Initial import, Ian Dunn, 2017/12/09