Commits

ZyX_I committed 39775e6

Added plugdict description

  • Participants
  • Parent commits d82318b

Comments (0)

Files changed (1)

                                                             *FraworRegister()*
 FraworRegister(version, sid, file, dependencies, oneload, g, F)
         Registers plugin sourced from {file} that has given {version} (see 
-        |frawor-t-version|). If {oneload} is true, then plugin is considered 
-        loaded when it is registered. Arguments {g} and {F} must contain 
-        dictionaries with global and function variables.
+        |frawor-t-version|; {version} must have at least two components). If 
+        {oneload} is true, then plugin is considered loaded when it is 
+        registered. {dependencies} argument is a dictionary that contains pairs 
+        {depplid} - {depversion} where each {depversion} must have at least one 
+        component. Arguments {g} and {F} must contain dictionaries with global 
+        and function variables.
         This function returns dictionary with the following keys:
         Key          Description ~
         id           Plugin identifier string. Normally it contains a list of 
 
 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*
         `Frawor:{plid}:{msgid}:{message}' where {message} is a value returned by 
         |frawor-f-warn|. Semicolon and backslash in {plid} and {msgid} will be 
         escaped.
-newfeature : function ({fid}, {fopts})
+newfeature : function ({fid}, {fopts})                   *frawor-f-newfeature*
+           + unload
         Registers plugin feature with id {fid} ({fid} must contain only digits, 
         latin letters and underscores). {fopts} is a dictionary with the 
         following keys (all are optional, but feature without any keys is