Commits

ZyX_I committed 77c83c3

doc: Made documentation use short notation whenever possible

  • Participants
  • Parent commits f68e7a6

Comments (0)

Files changed (2)

 
         call frawor#Reload('plugin/frawor')
 
+    or (shorter)
+
+        call frawor#Reload('@frawor')
+
     to reload all plugins (as they all depend on core frawor module).
 
 2. Frawor provides an easier way to mappings customization:
         2.1. Functions                         |frawor-functions|
         2.2. Commands                          |frawor-commands|
     3. Features                                |frawor-features|
-        3.1. Features defined in plugin/frawor |frawor-f-plugin/frawor|
-        3.2. @/functions features              |frawor-f-frawor/functions|
-        3.3. @/decorators features             |frawor-f-frawor/decorators|
+        3.1. Features defined in @frawor       |frawor-f-@frawor|
+        3.2. @/functions features              |frawor-f-@/functions|
+        3.3. @/decorators features             |frawor-f-@/decorators|
         3.4. @/decorators/altervars features   |frawor-f-decorators/altervars|
-        3.5. @/options features                |frawor-f-frawor/options|
-        3.6. @/checks features                 |frawor-f-frawor/checks|
-        3.7. @/fwc features                    |frawor-f-frawor/fwc|
-        3.8. @/mappings features               |frawor-f-frawor/mappings|
-        3.9. @/autocommands features           |frawor-f-frawor/autocommands|
-        3.10. @/commands features              |frawor-f-frawor/commands|
-        3.11. @/resources features             |frawor-f-frawor/resources|
-        3.12. @/python features                |frawor-f-frawor/python|
-        3.13. @/perl features                  |frawor-f-frawor/perl|
-        3.14. @/lua features                   |frawor-f-frawor/lua|
-        3.15. @/ruby features                  |frawor-f-frawor/ruby|
-        3.16. @/tcl features                   |frawor-f-frawor/tcl|
-        3.17. @/signs features                 |frawor-f-frawor/signs|
+        3.5. @/options features                |frawor-f-@/options|
+        3.6. @/checks features                 |frawor-f-@/checks|
+        3.7. @/fwc features                    |frawor-f-@/fwc|
+        3.8. @/mappings features               |frawor-f-@/mappings|
+        3.9. @/autocommands features           |frawor-f-@/autocommands|
+        3.10. @/commands features              |frawor-f-@/commands|
+        3.11. @/resources features             |frawor-f-@/resources|
+        3.12. @/python features                |frawor-f-@/python|
+        3.13. @/perl features                  |frawor-f-@/perl|
+        3.14. @/lua features                   |frawor-f-@/lua|
+        3.15. @/ruby features                  |frawor-f-@/ruby|
+        3.16. @/tcl features                   |frawor-f-@/tcl|
+        3.17. @/signs features                 |frawor-f-@/signs|
     4. Resources                               |frawor-resources|
         4.1. map resource                      |frawor-r-map|
         4.2. os resource                       |frawor-r-os|
         6. Calls |FraworRegister()|, passing it transformed {version}, s:_sid, 
            s:_sfile, transformed {dependencies}, {oneload} and s:.
         Example: >
-            execute frawor#Setup([0, 0], {"plugin/frawor": [0, 0]}, 0)
+            execute frawor#Setup([0, 0], {"@frawor": [0, 0]}, 0)
 <       You may replace [0, 0] here with "0.0", but remember that it is 
         frawor#Setup extension, it won't work with FraworRegister.
         Note: you must |:execute| frawor#Setup, not |:call| it.
 3. Features                                                  *frawor-features*
 
 ------------------------------------------------------------------------------
-3.1. Features defined in plugin/frawor                *frawor-f-plugin/frawor*
+3.1. Features defined in @frawor                            *frawor-f-@frawor*
 
 warn : function ({msgid}, ...) + s:_messages → {message}       *frawor-f-warn*
         Echoes message `Frawor:{plid}:{msgid}:{message}' where {message} is 
                    definer in dependencies.
 
 ------------------------------------------------------------------------------
-3.2. @/functions features                          *frawor-f-frawor/functions*
+3.2. @/functions features                               *frawor-f-@/functions*
 
 delfunctions : unloadpre + s:_functions                *frawor-f-delfunctions*
              + register + s:_functions
         savers/setters without making it accessible outside of plugin.
 
 ------------------------------------------------------------------------------
-3.3. @/decorators features                        *frawor-f-frawor/decorators*
+3.3. @/decorators features                             *frawor-f-@/decorators*
 
                                                        *frawor-f-adddecorator*
 adddecorator : function ({decid}, {decfunc})
                      argument.
 
 ------------------------------------------------------------------------------
-3.5. @/options features                              *frawor-f-frawor/options*
+3.5. @/options features                                   *frawor-f-@/options*
 
                                                           *frawor-f-getoption*
 getoption : function ({optname}[, {scopes}]) + s:_options, s:_oprefix
         |frawor-od-scopes|.
 
 ------------------------------------------------------------------------------
-3.6. @/checks features                                *frawor-f-frawor/checks*
+3.6. @/checks features                                     *frawor-f-@/checks*
 
 conschecker : function ({checker}[, {gdict}])           *frawor-f-conschecker*
         Creates a checker function. Constructed function takes exactly one 
         Like |frawor-f-conschecker|, but for filters, see |frawor-t-filter|.
 
 ------------------------------------------------------------------------------
-3.7. @/fwc features                                      *frawor-f-frawor/fwc*
+3.7. @/fwc features                                           *frawor-f-@/fwc*
 
                                                         *frawor-f-fwc.compile*
 fwc.compile : function ({FWCstring}, {type}[, {gdict}])
         Delete resources used by function with given ID.
 
 ------------------------------------------------------------------------------
-3.8. @/mappings features                            *frawor-f-frawor/mappings*
+3.8. @/mappings features                                 *frawor-f-@/mappings*
 
                                                        *frawor-f-mapgroup.add*
 mapgroup.add : function ({mgid}, {mappings}[, {mgopts}])
         that one which defined this group.
 
 ------------------------------------------------------------------------------
-3.9. @/autocommands features                    *frawor-f-frawor/autocommands*
+3.9. @/autocommands features                         *frawor-f-@/autocommands*
 
 augroup.add : function ({agid}, {events})               *frawor-f-augroup.add*
             + unload
             let s:_augroups+=['FooBar']
 
 ------------------------------------------------------------------------------
-3.10. @/commands features                           *frawor-f-frawor/commands*
+3.10. @/commands features                                *frawor-f-@/commands*
 
 delcommands : unloadpre + s:_commands                   *frawor-f-delcommands*
               register + s:_commands
         {cid} was specified, deletes all commands defined by caller.
 
 ------------------------------------------------------------------------------
-3.11. @/resources features                         *frawor-f-frawor/resources*
+3.11. @/resources features                              *frawor-f-@/resources*
 
                                                        *frawor-f-postresource*
 postresource : function ({rid}, {resource}[, {copyfunc}])
         so you don't need anything to get it working.
 
 ------------------------------------------------------------------------------
-3.12. @/python features                               *frawor-f-frawor/python*
+3.12. @/python features                                    *frawor-f-@/python*
 
 All @/python features are available only if vim is compiled with python 
 support.
         if it exists, then removes it when plugin is unloaded.
 
 ------------------------------------------------------------------------------
-3.13. @/perl features                                   *frawor-f-frawor/perl*
+3.13. @/perl features                                        *frawor-f-@/perl*
 
 All @/perl features are available only if vim is compiled with perl support.
 
         removes it when plugin is unloaded.
 
 ------------------------------------------------------------------------------
-3.14. @/lua features                                    *frawor-f-frawor/lua*
+3.14. @/lua features                                         *frawor-f-@/lua*
 
 All @/lua features are available only if vim is compiled with lua support.
 
         plugin is unloaded.
 
 ------------------------------------------------------------------------------
-3.15. @/ruby features                                   *frawor-f-frawor/ruby*
+3.15. @/ruby features                                        *frawor-f-@/ruby*
 
 All @/ruby features are available only if vim is compiled with ruby support.
 
         then removes it when plugin is unloaded.
 
 ------------------------------------------------------------------------------
-3.16. @/tcl features                                    *frawor-f-frawor/tcl*
+3.16. @/tcl features                                         *frawor-f-@/tcl*
 
 All @/tcl features are available only if vim is compiled with tcl support.
 
         removes it when plugin is unloaded.
 
 ------------------------------------------------------------------------------
-3.17. @/signs features                                 *frawor-f-frawor/signs*
+3.17. @/signs features                                      *frawor-f-@/signs*
 
 delsigns : unloadpre + s:_signs                            *frawor-f-delsigns*
             register + s:_signs
 
                   Defined in/  ~
     Varname       required for                 Description~
-*s:_sid*           autoload/frawor  Integer. Is set to current script id by 
+*s:_sid*           @%frawor         Integer. Is set to current script id by 
                                   |frawor#Setup()|.
-*s:_sfile*         autoload/frawor  String. Is set to script filename by 
+*s:_sfile*         @%frawor         String. Is set to script filename by 
                                   |frawor#Setup()|.
-*s:F*              autoload/frawor  Dictionary that is intended to hold all 
+*s:F*              @%frawor         Dictionary that is intended to hold all 
                                   plugin functions. Is initially set by 
                                   |frawor#Setup()|. It is not used by frawor 
                                   itself, but it is intended to be used by 
                                   plugins for internal purposes.
-*s:_pluginloaded*  plugin/frawor    Integer. Is set to 0 after plugin is 
+*s:_pluginloaded*  @frawor          Integer. Is set to 0 after plugin is 
                                   registered and then to 1 after plugin is 
                                   loaded.
-*s:_loading*       plugin/frawor    Integer. Is set to 1 when frawor started 
+*s:_loading*       @frawor          Integer. Is set to 1 when frawor started 
                                   to load non-oneload plugin and unset after 
                                   plugin was loaded.
-*s:_frawor*        plugin/frawor    Dictionary. Is set by |FraworRegister()|.
-*s:_messages*      plugin/frawor    Dictionary that contains strings as 
+*s:_frawor*        @frawor          Dictionary. Is set by |FraworRegister()|.
+*s:_messages*      @frawor          Dictionary that contains strings as 
                                   values. Required for |frawor-f-warn| and 
                                   |frawor-f-throw|.
-*s:_f*             plugin/frawor    Dictionary containing feature functions. 
+*s:_f*             @frawor          Dictionary containing feature functions. 
                                   Is set and populated by |FraworRegister()| 
                                   and |frawor-f-newfeature|.
-*s:_unload*        plugin/frawor    Reference to a function that will be 
+*s:_unload*        @frawor          Reference to a function that will be 
                                   called on plugin unloading 
                                   (|FraworUnload()|).
-*s:_options*       frawor/options   Dictionary that contains option 
+*s:_options*       @/options        Dictionary that contains option 
                                   definitions. Required for 
                                   |frawor-f-getoption|.
-*s:_oprefix*       frawor/options   String that contains option prefix. Is 
+*s:_oprefix*       @/options        String that contains option prefix. Is 
                                   used by |frawor-f-getoption|.
-*s:_augroups*      frawor/autocommands
-                                  List of strings containing augroup names. Is 
-                                  used by |frawor-f-delaugroups|.
-*s:_commands*      frawor/commands  List of strings containing command names. 
+*s:_augroups*      @/autocommands   List of strings containing augroup names. 
+                                  Is used by |frawor-f-delaugroups|.
+*s:_commands*      @/commands       List of strings containing command names. 
                                   Is used by |frawor-f-delcommands|.
-*s:_signs*         frawor/signs     List of strings containing sign names. Is 
+*s:_signs*         @/signs          List of strings containing sign names. Is 
                                   used by |frawor-f-delsigns|.
-*s:_functions*     frawor/functions List containing references to global and 
+*s:_functions*     @/functions      List containing references to global and 
                                   script-local functions or their names. Is 
                                   used by |frawor-f-delfunctions| and set by 
                                   |frawor#Setup()|.
-*s:_r*             frawor/resources Dictionary containing resources posted by 
+*s:_r*             @/resources      Dictionary containing resources posted by 
                                   plugins listed in dependencies. Is set by 
                                   |frawor-f-addresource|.
 ==============================================================================