summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEarl Miles2008-07-02 02:13:42 (GMT)
committer Earl Miles2008-07-02 02:13:42 (GMT)
commit080364ea2960ec148f691a3ac5f4856583930483 (patch)
tree72f5792976425c2cbf0a82bfab5bbabf83b5fb00
parent37911cfa911db6fe8588a6877e1561575254ba4d (diff)
#277508 by webchick
-rw-r--r--documentation-standards.txt6
-rw-r--r--help/getting-started.html34
2 files changed, 23 insertions, 17 deletions
diff --git a/documentation-standards.txt b/documentation-standards.txt
new file mode 100644
index 0000000..ea61135
--- /dev/null
+++ b/documentation-standards.txt
@@ -0,0 +1,6 @@
+- If the interface text is *bolded*, it got strong tags.
+- If it's a button they need to click, that's *bold* too.
+- If the text is not bolded (ex: links to click, options to check), it
+got /italicized/.
+- If it's user-entered text it got 'single quotes'.
+
diff --git a/help/getting-started.html b/help/getting-started.html
index 38c1792..f4df150 100644
--- a/help/getting-started.html
+++ b/help/getting-started.html
@@ -5,26 +5,26 @@ It helps to have something particular in mind that you want to accomplish when u
<h2>Create a page to list users by role</h2>
<ol>
-<li>Go to <a href="base_url:admin/build/views/add">add new view</a>.</li>
-<li>Give it the name 'user_list', tag 'users', type 'User' and click <strong>Next</strong>.</li>
-<li>On the left, select 'Page' and click <strong>Add Display</strong>.</li>
+<li>Go to <a target="_blank" href="base_url:admin/build/views/add">add new view</a>.</li>
+<li>Give it the name 'user_list', description 'A simple user listing.', tag 'users', type 'User' and click <strong>Next</strong>.</li>
+<li>On the left, ensure that 'Page' is selected, and click <strong>Add Display</strong>.</li>
<li>Next to <strong>Fields</strong> click the + icon to add fields.</li>
-<li>In the <strong>Group</strong> section select User, then check the following user fields: <em>Created date</em>, <em>Delete link</em>, <em>Edit link</em>, <em>Last access</em>, <em>Name</em> and <em>Picture</em>. Then click <strong>Add</strong></li>
-<li>You will be taken through the fields you added. For <em>Delete link</em> change the label to "Operations"; otherwise you can leave the options unchanged. Click <strong>Update</strong> to go to the next field.</li>
-<li>Under Page settings, click the <strong>Path</strong> setting. Set the path to 'user_list' (or something else if you prefer.)</li>
-<li>Click the <strong>Menu</strong> setting. Select <em>Normal menu entry</em> and set the title to "User list".</li>
-<li>At this point, you have done enough to create a valid view. If you scroll down, you will see a preview of your view. At any time you can click the <strong>Preview button</strong>, but whenever you finish one of the mini forms, the preview will update automatically, so you don't need to, generally.</li>
-<li>Next to <strong>Fields</strong> click the rearrange icon, which is to the right of the + icon to add fields. Drag the Name field to the top and the Delete link (Operations) field to the bottom, and the Edit link field just above it. Then click <strong>Update</strong></li>
-<li>Under the Basic settings, click the <strong>Style</strong> setting, which should default to "Unformatted". Change this to "Table".</li>
-<li>You will be taken to the table settings form. Next to <em>Edit link</em> change the column to <em>Operations</em>. Next to <em>Operations</em> set the Separator to " | " (note the spaces around the | symbol). Check all of the Sortable checkboxes, and set Default sort to <em>Name</em>.</li>
-<li>Click the + icon next to <strong>Filters</strong> and add the <em>User: Name</em> filter. Select <em>Is not one of</em> and enter Anonymous in the Usernames.</li>
-<li>Click on <strong>Use pager</strong> and change it to <em>Full</em>.</li>
-<li>Click on the <strong>add arguments</strong> icon, and add the <em>User: Roles</em> argument. Set the title to "%1", the "Action to take if argument is not present" to "Summary, sorted ascending", and leave the other settings as they are.</li>
-<li>Click <strong>Save</strong>.</li>
+<li>In the <strong>Groups</strong> section below, select 'User', then check the following user fields: <em>Created date</em>, <em>Delete link</em>, <em>Edit link</em>, <em>Last access</em>, <em>Name</em> and <em>Picture</em>. Then click <strong>Add</strong>.</li>
+<li>You will be taken through the fields you added one at a time. Click <strong>Update default display</strong> to go to the next field. Leave the default options on all fields except <em>Delete link</em>; change that field's label to 'Operations'.</li>
+<li>Under <strong>Page settings</strong>, click the <em>None</em> link next to the <em>Path</em> setting. Set the path to 'user_list' (or something else if you prefer) and click <strong>Update</strong>.</li>
+<li>Click the <em>No menu</em> link under the <em>Menu</em> setting. Select <em>Normal menu</em> and set the title to "User list" and click <strong>Update</strong>.</li>
+<li>At this point, you have done enough to create a valid view. If you scroll down, you will see a preview of your view. At any time you can click the <strong>Preview</strong> button, but whenever you finish one of the mini forms, the preview will update automatically, so you don't need to, generally.</li>
+<li>Next to <strong>Fields</strong>, click the rearrange icon, which is to the right of the + icon. Down below, drag the <em>Name</em> field to the top, the <em>Delete link (Operations)</em> field to the bottom, and the <em>Edit link</em> field just above it. Then click <strong>Update</strong>.</li>
+<li>Under the <strong>Basic settings</strong>, click the <em>Unformatted</em> link next to the <em>Style</em> setting. Change this to 'Table' below, and click <strong>Update default display</strong>.</li>
+<li>You will be taken to the table settings form. Next to <em>Edit link</em> change the column to <em>Operations</em>. Next to <em>Operations</em> set the Separator to ' | ' (note the spaces around the | symbol). Check all of the <em>Sortable</em> checkboxes, and set <em>Default sort</em> to 'Name'. When finished, click <strong>Update default display</strong>.</li>
+<li>Click the + icon next to <strong>Filters</strong>, select <em>User</em> under <strong>Groups</strong> below, choose the <em>User: Name</em> filter, and click <strong>Add</strong>.</li>
+<li>Select <em>Is not one of</em> and enter 'Anonymous' in the <strong>Usernames</strong> field. Click <strong>Update default display</strong>.</li>
+<li>Back under <strong>Basic settings</strong>, click the <em>No</em> link next to <em>Use pager</em>. Select <em>Full pager</em> and click <strong>Update default display</strong>.</li>
+<li>Next to <strong>Arguments</strong>, click + icon, choose the <em>User: Roles</em> argument, and click <strong>Add</strong>. Set the title to "%1", the "Action to take if argument is not present" to "Summary, sorted ascending". Leave the other settings as they are. Click <strong>Update default display</strong>, and click <strong>Update</strong> through the prompts that follow to accept their default values.</li>
+<li>Finally, click the <strong>Save</strong> button to save your work.</li>
<li>At the very top, click <strong>View "Page"</strong> to go to your new view!</li>
-
</ol>
<h3>Create a block to list recent story nodes</h3>
<ol>
-<li> TODO
+<li>TODO</li>
</ol>