TWiki/VarWEBLIST.mdwn

   1 <a name="VarWEBLIST"></a>
   2
   3 ### <a name="WEBLIST{&quot;format&quot;} -- index of al"></a> WEBLIST\{"format"\} -- index of all webs
   4
   5 - List of all webs. Obfusticated webs are excluded, e.g. webs with a `NOSEARCHALL = on` preference variable. The `"format"` defines the format of one web item. The `$name` variable gets expanded to the name of the web, `$qname` gets expanded to double quoted name, `$marker` to `marker` where web matches `selection`.
   6 - Syntax: `%WEBLIST{"format" ...}%`
   7 - Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
   8   <tr>
   9     <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
  10     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
  11     <th bgcolor="#99CCCC"><strong> Default: </strong></th>
  12   </tr>
  13   <tr>
  14     <td><code>"format"</code></td>
  15     <td> Format of one line, may include <code>$name</code> (the name of the web), $qname (the name of the web in double quotes), <code>$indentedname</code> (the name of the web with parent web names replaced by indents, for use in indented lists), and <code>$marker</code> (which expands to <code>marker</code> for the item matching <code>selection</code> only) </td>
  16     <td><code>"$name"</code></td>
  17   </tr>
  18   <tr>
  19     <td><code>format="format"</code></td>
  20     <td> (Alternative to above) </td>
  21     <td><code>"$name"</code></td>
  22   </tr>
  23   <tr>
  24     <td><code>separator=", "</code></td>
  25     <td> Line separator </td>
  26     <td><code>"$n"</code> (new line) </td>
  27   </tr>
  28   <tr>
  29     <td><code>web=""</code></td>
  30     <td> if you specify <code>$web</code> in format, it will be replaced with this </td>
  31     <td><code>""</code></td>
  32   </tr>
  33   <tr>
  34     <td><code>webs="public"</code></td>
  35     <td> Comma separated list of webs, <code>public</code> expands to all non-hidden.%BR% <strong><em>NOTE:</em></strong> Administrators will see all webs, not just the public ones </td>
  36     <td><code>"public"</code></td>
  37   </tr>
  38   <tr>
  39     <td><code>marker="selected"</code></td>
  40     <td> Text for <code>$marker</code> if the item matches <code>selection</code></td>
  41     <td><code>"selected"</code></td>
  42   </tr>
  43   <tr>
  44     <td><code>selection="%WEB%"</code></td>
  45     <td> Current value to be selected in list </td>
  46     <td><code>selection="%WEB%"</code></td>
  47   </tr>
  48   <tr>
  49     <td><code>subwebs="Sandbox"</code></td>
  50     <td> show webs that are a sub-web of this one (recursivly) </td>
  51     <td><code>""</code></td>
  52   </tr>
  53 </table>
  54 - Example: `%WEBLIST{"   * [[$name.WebHome]]"}%` - creates a bullet list of all webs.
  55 - Example: `<form><select name="web"> %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="%WEB%" separator=" "}% </select></form>` - creates a dropdown of all public webs + Trash web, with the current web highlighted.
  56 - Related: [[TOPICLIST|Main/VarTOPICLIST]], [[SEARCH|Main/VarSEARCH]]