Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Template:Orion/DocAPIRef"
(New page: <noinclude> This is a template for rendering jsdoc APIs as a relative link within the Orion documentation. This template should only be used in wiki pages that are being converted via wiki...) |
|||
| Line 7: | Line 7: | ||
; To render a function link without a given link name(className.functionName is used as link) | ; To render a function link without a given link name(className.functionName is used as link) | ||
| − | {{Usage|<pre>{{Orion/ | + | {{Usage|<pre>{{Orion/DocAPIRef|FileService|createFile}} |
| − | </pre>|2={{Orion/ | + | </pre>|2={{Orion/DocAPIRef|FileService|createFile}}}} |
; To render a function link with a given link name | ; To render a function link with a given link name | ||
| − | {{Usage|<pre>{{Orion/ | + | {{Usage|<pre>{{Orion/DocAPIRef|FileService|createFile|foo}} |
| − | </pre>|2={{Orion/ | + | </pre>|2={{Orion/DocAPIRef|FileService|createFile|foo}}}} |
; To render a class link without a given link name(className is used as link) | ; To render a class link without a given link name(className is used as link) | ||
| − | {{Usage|<pre>{{Orion/ | + | {{Usage|<pre>{{Orion/DocAPIRef|FileService}} |
| − | </pre>|2={{Orion/ | + | </pre>|2={{Orion/DocAPIRef|FileService}}}} |
; To render a class link with a given link name | ; To render a class link with a given link name | ||
| − | {{Usage|<pre>{{Orion/ | + | {{Usage|<pre>{{Orion/DocAPIRef|FileService||Eclipse Web File Service}} |
| − | </pre>|2={{Orion/ | + | </pre>|2={{Orion/DocAPIRef|FileService||Eclipse Web File Service}}}} |
</noinclude><includeonly>Refer to <a href="/help/topic/org.eclipse.orion.doc.isv/jsdoc/symbols/{{{1}}}.html#{{{2|}}}">{{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}</a> for API details</includeonly> | </noinclude><includeonly>Refer to <a href="/help/topic/org.eclipse.orion.doc.isv/jsdoc/symbols/{{{1}}}.html#{{{2|}}}">{{{3|{{{1}}}{{#if:{{{2|}}}|.|}}{{{2|}}}}}}</a> for API details</includeonly> | ||
Revision as of 13:39, 14 June 2011
This is a template for rendering jsdoc APIs as a relative link within the Orion documentation. This template should only be used in wiki pages that are being converted via wikitext into official Orion documentation. It takes a class name , function name and a desirable link name as parameter. Function name and/or desirable link name are optional. It renders a hyperlink of the JS-DOC URL for the the class or function.
- ==== Example =====
- To render a function link without a given link name(className.functionName is used as link)
| Markup | Rendering | |
|---|---|---|
|
- To render a function link with a given link name
| Markup | Rendering | |
|---|---|---|
|
- To render a class link without a given link name(className is used as link)
| Markup | Rendering | |
|---|---|---|
|
- To render a class link with a given link name
| Markup | Rendering | |
|---|---|---|
|