Commits

ZyX_I committed c57b8d1

Exchanged features and types, added s:g._pluginloaded assignment to frawor#Setup

  • Participants
  • Parent commits 424dca1

Comments (0)

Files changed (1)

         2.1. Functions                                  |frawor-functions|
         2.2. Commands                                   |frawor-commands|
     3. Options                                          |frawor-options|
-    4. Type definitions                                 |frawor-types|
+    4. Features                                         |frawor-features|
+    5. Type definitions                                 |frawor-types|
 
 ==============================================================================
 1. Intro                                                        *frawor-intro*
         some trailing `/' added), runtimepath will be empty.
 
 frawor#Setup(version, dependencies, oneload)                  *frawor#Setup()*
-        Creates s:F, s:g global variables, s:Eval function and registers 
-        a plugin using |FraworRegister()|, saving its return value to 
-        s:g._frawor. Usage: >
+        Creates s:F, s:g global variables, s:Eval function, creates 
+        s:g._pluginloaded variable and registers a plugin using 
+        |FraworRegister()|, saving its return value to s:g._frawor.
+        Usage: >
             execute frawor#Setup([0, 0], {"plugin/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.
         variable is defined (its content does not matter).
 
 ==============================================================================
-4. Types                                                        *frawor-types*
-
-version :: [ Integer ]                                      *frawor-t-version*
-        List of integers, all integers must be nonnegative.
-plugdict :: {}                                             *frawor-t-plugdict*
-        Dictionary which describes plugin. It has the following keys:
-        Key           Description ~
-        type          Plugin type (first path component after runtimepath or 
-                      empty).
-        id            Plugin id.
-        runtimepath   Plugin runtimepath (or empty if detection of rtp failed).
-        version       Plugin version, see |frawor-t-version|.
-        oneload       Bool, true if plugin should be loaded only once.
-        file          Path to plugin file.
-        sid           Plugin script id, see |<SID>|.
-        dependencies  Dictionary which contains pairs {plid} - {version}. When 
-                      dependency is loaded it is checked whether actual plugin 
-                      version is greater then requested plugin version 
-                      (excluding first component, it must be matched exactly).
-        status        Number that describes status of the plugin:
-                      0 - plugin is not loaded
-                      1 - plugin is registered, but not loaded
-                      2 - plugin is loaded
-        features      Dictionary which is populated by registered features, see 
-                      |frawor-f-newfeature|.
-        F             Dictionary with functions (last argument to 
-                      |FraworRegister()|).
-        g             Dictionary with global variables (last but one argument to 
-                      |FraworRegister()|).
-
-==============================================================================
-5. Features                                                  *frawor-features*
+4. Features                                                  *frawor-features*
 
 warn : function ({msgid}, ...) → {message}                     *frawor-f-warn*
         Echoes message `Frawor:{plid}:{message}' where {message} is obtained by 
                 plugdict.features[{fid}]. Note that if `load' key is present, 
                 then this key will be ignored.
 
+==============================================================================
+5. Type definitions                                             *frawor-types*
+
+version :: [ Integer ]                                      *frawor-t-version*
+        List of integers, all integers must be nonnegative.
+plugdict :: {}                                             *frawor-t-plugdict*
+        Dictionary which describes plugin. It has the following keys:
+        Key           Description ~
+        type          Plugin type (first path component after runtimepath or 
+                      empty).
+        id            Plugin id.
+        runtimepath   Plugin runtimepath (or empty if detection of rtp failed).
+        version       Plugin version, see |frawor-t-version|.
+        oneload       Bool, true if plugin should be loaded only once.
+        file          Path to plugin file.
+        sid           Plugin script id, see |<SID>|.
+        dependencies  Dictionary which contains pairs {plid} - {version}. When 
+                      dependency is loaded it is checked whether actual plugin 
+                      version is greater then requested plugin version 
+                      (excluding first component, it must be matched exactly).
+        status        Number that describes status of the plugin:
+                      0 - plugin is not loaded
+                      1 - plugin is registered, but not loaded
+                      2 - plugin is loaded
+        features      Dictionary which is populated by registered features, see 
+                      |frawor-f-newfeature|.
+        F             Dictionary with functions (last argument to 
+                      |FraworRegister()|).
+        g             Dictionary with global variables (last but one argument to 
+                      |FraworRegister()|).
+
 vim: ft=help:tw=78