RedmineWikis » History » Version 28
Mikkel Kirkgaard Nielsen, 2016-03-18 12:06
toolbar in separate heading, +toolbar screenshot, describe edit+watch+delete, fix some spelling
1 | 27 | Ben Blanco | h1. Wikis |
---|---|---|---|
2 | 1 | Thomas Lecavelier | |
3 | 27 | Ben Blanco | {{>toc}} |
4 | 27 | Ben Blanco | |
5 | 28 | Mikkel Kirkgaard Nielsen | |
6 | 27 | Ben Blanco | h2. Creating a new wiki page |
7 | 27 | Ben Blanco | |
8 | 27 | Ben Blanco | As in every wiki, just add a link to the page you want to create. |
9 | 27 | Ben Blanco | |
10 | 27 | Ben Blanco | <pre>[[MyNewWikiPage]]</pre> |
11 | 1 | Thomas Lecavelier | |
12 | 28 | Mikkel Kirkgaard Nielsen | Save the page and click on that link: you are now editing the new wiki page with the name "MyNewWikiPage". Follow the *Edit* instructions below. |
13 | 1 | Thomas Lecavelier | |
14 | 1 | Thomas Lecavelier | |
15 | 27 | Ben Blanco | h2. Creating sub-pages (parent/child relationships) |
16 | 27 | Ben Blanco | |
17 | 28 | Mikkel Kirkgaard Nielsen | It is possible to create parent/child relationships between wiki pages. This has two benefits: |
18 | 28 | Mikkel Kirkgaard Nielsen | * On the "[[RedmineWikis#Sidebar|Index by title]]", the page tree is sorted according to the relationships: |
19 | 27 | Ben Blanco | > * Guide |
20 | 27 | Ben Blanco | > ** RedmineAccounts |
21 | 27 | Ben Blanco | > ** RedmineCustomFields |
22 | 27 | Ben Blanco | > ** RedmineInstall |
23 | 27 | Ben Blanco | > ** RedmineIssueList |
24 | 1 | Thomas Lecavelier | > ** RedmineIssues |
25 | 27 | Ben Blanco | * On each child page a breadcrumb is displayed showing the location of the page within the page tree: |
26 | 27 | Ben Blanco | TODO, add image |
27 | 27 | Ben Blanco | |
28 | 27 | Ben Blanco | These relations can be set by assigning a parent page to a to-be child-page. |
29 | 1 | Thomas Lecavelier | |
30 | 28 | Mikkel Kirkgaard Nielsen | h2. Toolbar |
31 | 1 | Thomas Lecavelier | |
32 | 28 | Mikkel Kirkgaard Nielsen | Each wiki page has a toolbar located in the upper right corner with buttons for actions to perform on the page. Depending on the [[RedmineRoles|Roles and permissions]] of the site your user might not have permission to perform some of the actions, in this case the respective button will not be displayed at all. |
33 | 1 | Thomas Lecavelier | |
34 | 28 | Mikkel Kirkgaard Nielsen | p=. !wiki-toolbar.png! |
35 | 1 | Thomas Lecavelier | |
36 | 28 | Mikkel Kirkgaard Nielsen | The actions are explained below. |
37 | 1 | Thomas Lecavelier | |
38 | 28 | Mikkel Kirkgaard Nielsen | h3. Edit |
39 | 28 | Mikkel Kirkgaard Nielsen | |
40 | 28 | Mikkel Kirkgaard Nielsen | To edit the current contents of a wiki page click the *Edit* button. See [[RedmineTextFormatting]] for details about text annotation. The pages's parent can be changed by using the drop down box "Parent page". |
41 | 28 | Mikkel Kirkgaard Nielsen | |
42 | 28 | Mikkel Kirkgaard Nielsen | h3. Watch |
43 | 28 | Mikkel Kirkgaard Nielsen | |
44 | 28 | Mikkel Kirkgaard Nielsen | Clicking the *Watch* button adds you as a watcher of the page. This means you will be notified of changes to the page by email. |
45 | 28 | Mikkel Kirkgaard Nielsen | |
46 | 28 | Mikkel Kirkgaard Nielsen | |
47 | 28 | Mikkel Kirkgaard Nielsen | h3. Rename (or move) |
48 | 28 | Mikkel Kirkgaard Nielsen | |
49 | 28 | Mikkel Kirkgaard Nielsen | To rename a wiki page or move a wiki page and its children to another project, click on the !/images/move.png! *Rename* button. |
50 | 28 | Mikkel Kirkgaard Nielsen | |
51 | 28 | Mikkel Kirkgaard Nielsen | If 'Redirect existing links' is checked, existing links to the current page are redirected to the new wiki page when renamed or moved. Links to the children-pages move to other project are not redirected. To stop the redirection see a workaround in #6401#note-8. |
52 | 28 | Mikkel Kirkgaard Nielsen | |
53 | 1 | Thomas Lecavelier | You can specify a parent page in 'Parent page'. |
54 | 27 | Ben Blanco | |
55 | 27 | Ben Blanco | You can move a page to another project by specifying the destination project in 'Project'. When moving a page, each child page is also moved unless the destination project contains a page with the same name. |
56 | 27 | Ben Blanco | |
57 | 28 | Mikkel Kirkgaard Nielsen | h3. Lock (protect) |
58 | 27 | Ben Blanco | |
59 | 28 | Mikkel Kirkgaard Nielsen | Clicking the !/images/locked.png! *Lock* button locks the page, and transforms the button into !/images/unlock.png! *Unlock*. |
60 | 27 | Ben Blanco | |
61 | 28 | Mikkel Kirkgaard Nielsen | A locked wiki page can only be edited by users who have the permission to protect wiki pages, these users can also unlock it again by clicking *Unlock*. |
62 | 27 | Ben Blanco | |
63 | 28 | Mikkel Kirkgaard Nielsen | h3. Delete |
64 | 28 | Mikkel Kirkgaard Nielsen | |
65 | 28 | Mikkel Kirkgaard Nielsen | Click *Delete* to delete the wiki page. A confirmation is needed to perform the action. |
66 | 28 | Mikkel Kirkgaard Nielsen | |
67 | 28 | Mikkel Kirkgaard Nielsen | |
68 | 28 | Mikkel Kirkgaard Nielsen | h3. History |
69 | 27 | Ben Blanco | |
70 | 27 | Ben Blanco | Redmine keeps a record of every change made to a wiki page. You can view the list of these changes by clicking on !/images/history.png! *History*. |
71 | 27 | Ben Blanco | |
72 | 27 | Ben Blanco | p=. !history.png! |
73 | 27 | Ben Blanco | |
74 | 27 | Ben Blanco | To view a specific version of the page click on its number. |
75 | 27 | Ben Blanco | |
76 | 27 | Ben Blanco | p=. !page_version.png! |
77 | 27 | Ben Blanco | |
78 | 27 | Ben Blanco | What is displayed can be misleading: @Version 31/41 (diff)@ means that you are viewing version 31 out of 41, it does not mean that the diff link will show you the differences between 31 and 41. It does show you the differences between version 30 and 31. If you're looking at version 30, you'll see Version 30/41, and the diff will show you the changes in version 30. |
79 | 27 | Ben Blanco | |
80 | 27 | Ben Blanco | If you want to see differences between 40 and 41, go to the revisions list and click 'View changes' (by default, it will show the diff of the last version). |
81 | 27 | Ben Blanco | |
82 | 27 | Ben Blanco | You can revert a page to a previous version by clicking on !/images/cancel.png! *Rollback to this version*, then *Save*. In that case a new page version is created without losing the wiki page history. |
83 | 27 | Ben Blanco | |
84 | 27 | Ben Blanco | If you instead do want to delete all history of a wiki page you have to copy the content of that page to a safe place (copy/paste in edit window), delete the page and re-create it with the same name. Then re-insert the copied content. |
85 | 27 | Ben Blanco | |
86 | 27 | Ben Blanco | h2. Sidebar |
87 | 27 | Ben Blanco | |
88 | 27 | Ben Blanco | The content of the wiki page named '@Sidebar@' is rendered in the wiki sidebar if it exists. Permission to protect wiki pages is required to create this page. |
89 | 27 | Ben Blanco | |
90 | 27 | Ben Blanco | The contextual sidebar on the right of any wiki page provides links to: |
91 | 27 | Ben Blanco | * *Start page*: Link to the [[RedmineProjectSettings#Wiki|configured start page]] of the wiki |
92 | 27 | Ben Blanco | * *Index by title*: Index of all the wiki pages sorted by name (and, if [[RedmineWikis#Creating-sub-pages-parentchild-relationships|configured]], by parent/child relationships) |
93 | 27 | Ben Blanco | |
94 | 27 | Ben Blanco | p=. TODO, add image |
95 | 27 | Ben Blanco | * *Index by date*: Index of all the wiki pages sorted by date of last modification |
96 | 27 | Ben Blanco | |
97 | 1 | Thomas Lecavelier | p=. TODO, add image |