Author: rklochkov Date: Sat Jan 26 12:28:43 2013 New Revision: 17

Log: Documentation

Modified: README.md package.lisp

Modified: README.md ============================================================================== --- README.md Sat Jan 26 12:15:48 2013 (r16) +++ README.md Sat Jan 26 12:28:43 2013 (r17) @@ -24,6 +24,9 @@ ------------------

Advanced-readtable has fully functional built-in support of hierarchy-packages. +.name means "subpackage name in current package", ..name -- "subpackage name in above package", +...name -- "subpackage in two-level-up package" and so on. +In in-package you may use .. for above package, ... for two level up, and so on.

CL-USER> (defpackage .test (:use cl))) #<PACKAGE "COMMON-LISP-USER.TEST"> @@ -145,8 +148,8 @@ -------------

There are five lists: -- *package-finders* -- global for find-package -- *symbol-finders* -- global for find-symbol +- `*package-finders*` -- global for find-package +- `*symbol-finders*` -- global for find-symbol - (package-finders package) -- per-package for find-package - (symbol-finders package) -- per-package for find-symbol - (extra-finders symbol) -- per-symbol for (symbol ....) package substitution @@ -168,3 +171,19 @@ will set handler for package pack, if there are no hanler with key (:my handler1). So you may set it in your file and not be afraid, that it will duplicate on reloading. + +Restrictions +------------ + +You must only ASCII characters for first letter of every part of package name +and for first letter of symbols, that you want to use in set-macro-symbol + +If you really need other characters you may set them by calling + + (set-macro-character c #'advanced-readtable:read-token-with-colons t) + +for every your character. + +If you need to temporary disable macro-characted substitution, you may set +`advanced-readtable:*enable-symbol-readmacro*` to nil. It could be useful, if you +describe a lot of symbols and don't want to enclose every of them in || (and upcase, of course).

Modified: package.lisp ============================================================================== --- package.lisp Sat Jan 26 12:15:48 2013 (r16) +++ package.lisp Sat Jan 26 12:28:43 2013 (r17) @@ -16,11 +16,9 @@ #:*package-finders* #:*symbol-finders* #:*extra-finders* - #:*advanced-readtable* - #:*disable-symbol-readmacro* + #:*enable-symbol-readmacro* #:push-import-prefix #:push-local-nickname #:push-local-package #:set-handler - #:enable-global-nicknames - #:enable-hierarchy-packages)) + #:read-token-with-colons))