Changes for page XWiki HowTo’s

Last modified by Roman Friesen on 2009/10/03 10:51
From version Icon 3.1 Icon
edited by Roman Friesen
on 2009/09/15 18:31
Change comment: links and translation howto added
To version Icon 4.1 Icon
edited by Roman Friesen
on 2009/09/16 12:50
Change comment: Disabling comments etc.

Summary

Details

Icon Page properties
Content
... ... @@ -2,9 +2,13 @@
2 2  
3 3  {{toc start="2" numbered="true" depth="3"/}}
4 4  
5 -== General ==
5 +== General information ==
6 6  * [[Features / Applications >> http://enterprise.xwiki.org/xwiki/bin/view/Main/Features]]
7 -* [[Advanced (Developer) guide >>http://platform.xwiki.org/xwiki/bin/view/DevGuide/]]
7 +* [[Getting Started >>http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/]]
8 +** [[First steps>>http://enterprise.xwiki.org/xwiki/bin/view/GettingStarted/]]
9 +* [[Administrator Guide >>http://platform.xwiki.org/xwiki/bin/view/AdminGuide/]]
10 +* [[Advanced User guide >>http://platform.xwiki.org/xwiki/bin/view/DevGuide/]]
11 +** [[Best Practices >> http://platform.xwiki.org/xwiki/bin/view/DevGuide/Best+Practices+XWiki+Application+Organization]]
8 8  * [[Developer guide >>http://dev.xwiki.org/xwiki/bin/view/Main/]]
9 9  * [[Code Zone >>http://code.xwiki.org/xwiki/bin/view/Main/]]
10 10  
... ... @@ -37,6 +37,27 @@
37 37  {{/code}}
38 38  
39 39  
44 +=== Create Velocity Macro ===
45 +
46 +{{warning}}A write access to your XWiki installation directory is required!{{/warning}}
47 +
48 +1. Add a new macro to the file "macros.vm"
49 +1*. see "<xwiki-installation-root>/xwiki/templates"
50 +1*. add at the end of the file your new macro, for example:
51 +{{code}}#macro(myMacroName)
52 +Hello World!
53 +#end{{/code}}
54 +1. Register the new macro in the file "macros.txt"
55 +1*. see "<xwiki-installation-root>/xwiki/templates"
56 +1*. add at the end of the file the line, for example:
57 +{{code}}myMacroName=velocity:myMacroName:{{/code}}
58 +1. After XWiki restart the new velocity macro can be used in a common way: either using the WYSIWYG editor or [[text mode>>http://code.xwiki.org/xwiki/bin/view/Macros/]].
59 +
60 +
61 +== Translations ==
62 +* [[Internationalization feature >> http://platform.xwiki.org/xwiki/bin/view/Features/I18N]]
63 +* [[Writing Internationalized XWiki Applications >> http://platform.xwiki.org/xwiki/bin/view/DevGuide/InternationalizingApplications]]
64 +
40 40  === Translation of Panels ===
41 41  ==== With an if/else-block ====
42 42  1. Put the following velocity script into your panel
... ... @@ -56,7 +56,7 @@
56 56  
57 57  1. That is all :)
58 58  ==== Loading a translated page into the panel ====
59 -{{warning}}Maybe the macro "includeForm()" is not the best choice here, see [[including macros >> http://platform.xwiki.org/xwiki/bin/view/DevGuide/IncludeInVelocity]].{{/warning}}
84 +{{warning}}Maybe the macro "includeForm()" is not the best choice here, see [[including macros>> http://platform.xwiki.org/xwiki/bin/view/DevGuide/IncludeInVelocity]].{{/warning}}
60 60  
61 61  1. Creates a new wiki page with translated content, for example 'Main.MyMenu'.
62 62  1. Include this page in your panel, for example:
... ... @@ -70,18 +70,28 @@
70 70  
71 71  1. That is all :)
72 72  
73 -=== Create Velocity Macro ===
98 +== Disabling comments, attacments, history and information ==
99 +Currently (xwiki-2.0) there is no way to disable this parts from viewing. This parts can be only made invisible at the bottom of pages (tabbed pane).
74 74  
75 -{{warning}}A write access to your XWiki installation directory is required!{{/warning}}
101 +{{warning}} This workaround may work only with xwiki default skins {{/warning}}
76 76  
77 -1. Add a new macro to the file "macros.vm"
78 -1*. see "<xwiki-installation-root>/xwiki/templates"
79 -1*. add at the end of the file your new macro, for example:
80 -{{code}}#macro(myMacroName)
81 -Hello World!
82 -#end{{/code}}
83 -1. Register the new macro in the file "macros.txt"
84 -1*. see "<xwiki-installation-root>/xwiki/templates"
85 -1*. add at the end of the file the line, for example:
86 -{{code}}myMacroName=velocity:myMacroName:{{/code}}
87 -1. After XWiki restart the new velocity macro can be used in a common way: either using the WYSIWYG editor or [[text mode>>http://code.xwiki.org/xwiki/bin/view/Macros/]].
103 +1. Change to the Administration page of you xwiki
104 +1. Call the class editor (<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class)
105 +11. Add the following properties (type Boolean)
106 +11*. showcomments
107 +11*. showattachments
108 +11*. showhistory
109 +11*. showinformation
110 +11. Save changes
111 +1. Call the object editor (<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object)
112 +11. Expand "Objects of type XWiki.XWikiPreferences / XWikiPreferences"
113 +11. Change the values for all new properties to "No"
114 +11. Save changes
115 +1. The bottom tabbed pane will disappear, but you can still access this informations through the menu "Show".
116 +
117 +See also:
118 +* [[Disabling at the page or space level >>http://osdir.com/ml/web.wiki.xwiki.user/2008-01/msg00055.html]]
119 +* [[related jira task "XWIKI-3027" >>http://jira.xwiki.org/jira/browse/XWIKI-3027]]
120 +* [[related FAQ >> http://www.xwiki.org/xwiki/bin/view/FAQ/Howtodisablecommentsandattachments]]
121 +* [[Admin Configuration guide >>http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Configuration]]
122 +