Update docs to remove 'lib' references.

jrburke · jrburke · commit efd1109e2032 · 2011-05-20T14:18:42.000-07:00
diff --git a/docs/api.html b/docs/api.html
@@ -629,15 +629,15 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 <ul>
 <li><strong>name</strong>: The name of the package (used for the module name/prefix mapping)</li>
 <li><strong>location</strong>: The location on disk. Locations are relative to the baseUrl configuration value, unless they contain a protocol or start with a front slash (/).</li>
-<li><strong>lib</strong>: The name of the directory inside the package folder that contains modules. The default value is "lib", so no need to specify it unless it is different than the default.</li>
-<li><strong>main</strong>: The name of the module inside the package that should be used when someone does a require for "packageName". The default value is "lib/main", so only specify it if it differs from the default. The value is relative to the package folder.</li>
+<li><strong>main</strong>: The name of the module inside the package that should be used when someone does a require for "packageName". The default value is "main", so only specify it if it differs from the default. The value is relative to the package folder.</li>
 </ul></li>
 </ul>
 
 <p><strong>IMPORTANT NOTES</strong></p>
 
 <ul>
 <li>While the packages can have the CommonJS directory layout, the modules themselves should be in a module format that RequireJS can understand. Exception to the rule: if you are using the r.js Node adapter, the modules can be in the traditional CommonJS module format. You can use the <a href="commonjs.html#autoconversion">CommonJS converter tool</a> if you need to convert traditional CommonJS modules into the async module format that RequireJS uses.</li>
+<li>The <strong>lib</strong> directory option that may be used in packages is not supported. It causes some confusing path issues.</li>
 <li>Only one version of a package can be used in a project context at a time. You can use RequireJS <a href="#multiversion">multiversion support</a> to load two different module contexts, but if you want to use Package A and B in one context and they depend on different versions of Package C, then that will be a problem. This may change in the future.</li>
 </ul>
 
@@ -671,34 +671,22 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 <ul>
 <li>alpha/
 <ul>
-<li>lib/
-<ul>
 <li>main.js</li>
 </ul></li>
-</ul></li>
 <li>omega/
 <ul>
-<li>lib/
-<ul>
 <li>main.js</li>
 </ul></li>
 </ul></li>
-</ul></li>
 <li>cart/
 <ul>
-<li>lib/
-<ul>
 <li>main.js</li>
 </ul></li>
-</ul></li>
 <li>store/
 <ul>
-<li>lib/
-<ul>
 <li>main.js</li>
 <li>util.js</li>
 </ul></li>
-</ul></li>
 <li>main.js</li>
 <li>package.json</li>
 <li>require.js</li>
@@ -738,9 +726,9 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 });
 </code></pre>
 
-<p>A require of "alpha" means that it will be loaded from <strong>scripts/.packages/alpha/lib/main.js</strong>, since "lib" and "main" are the default lib directory and main module settings supported by RequireJS. A require of "store/util" will be loaded from <strong>scripts/store/lib/util.js</strong>.</p>
+<p>A require of "alpha" means that it will be loaded from <strong>scripts/.packages/alpha/main.js</strong>, since "main" is the default main module setting supported by RequireJS. A require of "store/util" will be loaded from <strong>scripts/store/util.js</strong>.</p>
 
-<p>If the "alpha" and "store" packages did not follow the "lib" and "main.js" conventions, and looked more like this:</p>
+<p>If the "alpha" and "store" packages did not follow the "main.js" convention, and looked more like this:</p>
 
 <ul>
 <li>project-directory/
@@ -753,26 +741,17 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
 <ul>
 <li>alpha/
 <ul>
-<li>scripts/
-<ul>
 <li>index.js</li>
 </ul></li>
-</ul></li>
 <li>omega/
 <ul>
-<li>lib/
-<ul>
 <li>main.js</li>
 </ul></li>
 </ul></li>
-</ul></li>
 <li>cart/
 <ul>
-<li>lib/
-<ul>
 <li>main.js</li>
 </ul></li>
-</ul></li>
 <li>store/
 <ul>
 <li>store.js</li>
@@ -792,7 +771,6 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
         ".packages": [
             {
                 name: "alpha",
-                lib: "scripts",
                 main: "index"
             },
             "omega"
@@ -802,7 +780,6 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
         "cart",
         {
             name: "store",
-            lib: ".",
             main: "store"
         }
     ]
@@ -816,7 +793,6 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
         {
             name: "alpha",
             location: ".packages/alpha",
-            lib: "scripts",
             main: "index"
         },
         {
@@ -826,14 +802,13 @@ <h3><a name="packages">Loading Modules from Packages</a><span class="sectionMark
         "cart",
         {
             name: "store",
-            lib: ".",
             main: "store"
         }
     ]
 });
 </code></pre>
 
-<p>To avoid verbosity, it is strongly suggested to always use packages that use the "lib" and "main" conventions in their structure, and use packagePaths for third party packages.</p>
+<p>To avoid verbosity, it is strongly suggested to always use packages that use "main" convention in their structure, and use packagePaths for third party packages.</p>
 
 <p>To make fetching and configuring packages easier, there are designs for a command line package tool in the works.</p>
 
diff --git a/tasks.txt b/tasks.txt
@@ -9,7 +9,11 @@ Release Notes
 Next release
 --------------
 
-- relative modules IDs? remove lib?
+- relative modules IDs?
+  - excludeShallow not excluding files loaded with the text plugin: email thread. Exclusions.
+
+- Remove nameToUrl use in plugins/public code.
+  - Make sure it is not in the docs
 
 - text plugins after a build load xdomain?
 - Why can't plugins have dependencies? It is because the dependency is not fully evaluated.
