Changes for page Scripting

Last modified by Simon Urli on 2023/10/10

<
From version < 50.5 >
edited by Vincent Massol
on 2017/09/01
To version < 50.6 >
edited by Vincent Massol
on 2017/09/01
>
Change comment: Updated the relative links.

Summary

Details

Page properties
Content
... ... @@ -67,9 +67,9 @@
67 67  
68 68  = XWiki Scripting API =
69 69  
70 -The API is documented in Javadoc format and can be accessed here: [[XWiki API Javadoc>>DevGuide.API]]. If you are not familiar with Java or object oriented programming, you will probably be confused by the API documentation. It is not within the scope of our documentation to teach you all the details about Java, or object oriented programming. You can find all of that information already online. You can also explore the page code found throughout the [[Extensions wiki>>extensions:Main.WebHome]] area to see how others have figured out how to achieve a variety of results.
70 +The API is documented in Javadoc format and can be accessed here: [[XWiki API Javadoc>>platform:DevGuide.API]]. If you are not familiar with Java or object oriented programming, you will probably be confused by the API documentation. It is not within the scope of our documentation to teach you all the details about Java, or object oriented programming. You can find all of that information already online. You can also explore the page code found throughout the [[Extensions wiki>>extensions:Main.WebHome]] area to see how others have figured out how to achieve a variety of results.
71 71  
72 -We're also making available an [[API Guide>>APIGuide]] with examples about using the XWiki API.
72 +We're also making available an [[API Guide>>platform:DevGuide.APIGuide]] with examples about using the XWiki API.
73 73  
74 74  == [[Bindings>>extensions:Extension.Script Macro#HBindings]] ==
75 75  
... ... @@ -83,11 +83,11 @@
83 83  * The XWiki utils: **##util##** (this is deprecated)
84 84  * Various [[Script Services>>extensions:Extension.Script Module]]: **##services##**
85 85  
86 -See [[Scripting Reference Documentation>>SRD.Navigation]] for a complete list.
86 +See [[Scripting Reference Documentation>>platform:SRD.Navigation]] for a complete list.
87 87  
88 88  == [[XWiki Component>>extensions:Extension.Component Module]] Access ==
89 89  
90 -Since XWiki 4.1M2+ there's a Script Service to access the Component Manager (see also: [[Accessing components from Groovy>>DevGuide.WritingComponents#HFromwikipages]]).
90 +Since XWiki 4.1M2+ there's a Script Service to access the Component Manager (see also: [[Accessing components from Groovy>>platform:DevGuide.WritingComponents#HFromwikipages]]).
91 91  
92 92  For example using Groovy you'd write:
93 93  
... ... @@ -147,13 +147,13 @@
147 147  
148 148  = Velocity Specific Information =
149 149  
150 -Velocity is currently the only scripting language which can be used without Programming [[AdminGuide.Access Rights]]. This means you can save Velocity scripts using a user with less permissions and nobody will be able to exploit your script to perform a security breach.
150 +Velocity is currently the only scripting language which can be used without Programming [[platform:AdminGuide.Access Rights]]. This means you can save Velocity scripts using a user with less permissions and nobody will be able to exploit your script to perform a security breach.
151 151  
152 -You can [[gain access to the XWiki core>>#HXWikiCoreAccess]] from Velocity but this will require Programming Rights. Strictly speaking, protected APIs are only available when the page that contains them was last saved by someone who had Programming Rights (see above).
152 +You can [[gain access to the XWiki core>>platform:DevGuide.Scripting#HXWikiCoreAccess]] from Velocity but this will require Programming Rights. Strictly speaking, protected APIs are only available when the page that contains them was last saved by someone who had Programming Rights (see above).
153 153  
154 -In Velocity you can't import classes and as such you cannot gain direct access to XWiki components as shown [[above>>#HXWikiComponentAccess]]. This leaves you with the provided [[bindings>>#HBindings]] (NOTE: In Velocity, these bindings all start with **##$##** as with all other Velocity variables)
154 +In Velocity you can't import classes and as such you cannot gain direct access to XWiki components as shown [[above>>platform:DevGuide.Scripting#HXWikiComponentAccess]]. This leaves you with the provided [[bindings>>platform:DevGuide.Scripting#HBindings]] (NOTE: In Velocity, these bindings all start with **##$##** as with all other Velocity variables)
155 155  
156 -For more information about programming in the Velocity language, you can refer to the [[Velocity User Guide>>http://velocity.apache.org/engine/releases/velocity-1.7/user-guide.html]]. See also this [[Velocity Training Presentation>>XWikiVelocityTraining]].
156 +For more information about programming in the Velocity language, you can refer to the [[Velocity User Guide>>http://velocity.apache.org/engine/releases/velocity-1.7/user-guide.html]]. See also this [[Velocity Training Presentation>>platform:DevGuide.XWikiVelocityTraining]].
157 157  
158 158  For more details on using Velocity check the [[Velocity Module Documentation>>extensions:Extension.Velocity Module]] which also contains the full list of Velocity Tools that you can use in your scripts.
159 159  
... ... @@ -161,7 +161,7 @@
161 161  If you wish to add new Velocity tools you'll need to edit your ##xwiki.properties## file and follow the instructions in there.
162 162  {{/info}}
163 163  
164 -To include Velocity scripts in other Velocity scripts, see [[How to include a Velocity page into another page>>DevGuide.IncludeInVelocity]].
164 +To include Velocity scripts in other Velocity scripts, see [[How to include a Velocity page into another page>>platform:DevGuide.IncludeInVelocity]].
165 165  
166 166  == Other Velocity Variables ==
167 167  

Get Connected