0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/06/28 04:59

From version 34.1
edited by Ryan C
on 2025/05/14 16:06
Change comment: There is no comment for this version
To version 14.1
edited by Ryan C
on 2025/05/14 13:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -12,10 +12,56 @@
12 12  
13 13  == Getting Started with XWiki ==
14 14  
15 -The example macro in XWiki is an underrated powerhouse—great for *teaching*, *showcasing macros*, *hiding complex markup*, and *letting users play with source-output pairs*. Here are some **highly effective and interesting uses**:
15 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
16 16  
17 +== ==
17 17  
19 +== 📎 **Attachments and Images** ==
18 18  
21 +You can easily upload files and images directly from the WYSIWYG editor:
22 +
23 +**Uploading Attachments:**
24 +
25 +* Click **Edit** to enter the WYSIWYG editor.
26 +* Click on the **Attachment** icon (📎 paperclip icon).
27 +* Drag-and-drop or select your file to upload it instantly.
28 +* Uploaded files will automatically be listed as attachments at the bottom of your page.
29 +
30 +=== **Inserting Images with Enlargable Thumbnails** ===
31 +
32 +1. In the editor, click the **"Insert Image"** icon from the toolbar.
33 +1. Upload or select the image.
34 +1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
35 +
36 +----
37 +
38 +== ⚡ **Using the / Macro Shortcut** ==
39 +
40 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
41 +
42 +* Simply type / and start typing the macro name or feature you want to add.
43 +* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
44 +* Example macros include:
45 +** /toc – Table of Contents
46 +** /box – Insert Box Macro
47 +** /gallery – Image Gallery
48 +** /footnote – Add footnotes to your text
49 +** /code – Code blocks for programming snippets
50 +
51 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
52 +
53 +----
54 +
55 +== ✏️** Basic Formatting and Links (Quick Guide)** ==
56 +
57 +* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
58 +* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
59 +* **Creating Links**:
60 +** Highlight text and click **"Link"** or use shortcut Ctrl+K.
61 +** Paste or select the page URL to link internally.
62 +
63 +----
64 +
19 19  == 🔍 **Useful Tips & Best Practices** ==
20 20  
21 21  * **Save drafts frequently:** Press Ctrl+S regularly.
... ... @@ -48,6 +48,7 @@
48 48  
49 49  * **WYSIWYG (What You See Is What You Get) Editor**: Ideal for users unfamiliar with wiki syntax, this editor provides a user-friendly interface resembling traditional word processors. It allows for straightforward text formatting, image insertion, and link creation without delving into markup language. citeturn0search0
50 50  * **Wiki Editor**: This mode enables direct editing using XWiki’s markup syntax. It’s suitable for users comfortable with wiki syntax and those requiring precise control over the content structure.
97 +* **Inline Form Editing**: Used primarily for pages containing structured data or custom applications, this mode presents editable fields directly within the page view, streamlining data entry and updates.
51 51  
52 52  == **Essential Formatting Options** ==
53 53  
... ... @@ -62,182 +62,102 @@
62 62  {{/code}}
63 63  
64 64  
65 -== **Links** ==
112 +=== **Text Formatting** ===
66 66  
67 67  
68 68  
69 -==== **Internal Link**: Use square brackets with the page name. ====
116 +*
117 +** (((
118 +=== **Bold**: Surround text with double asterisks. ===
119 +)))
70 70  
71 71  {{code}}
72 -[[PageName]]
122 +**bold text**
73 73  {{/code}}
74 74  
75 75  
126 +*
127 +** (((
128 +=== **Italics**: Use double underscores. ===
129 +)))
76 76  
77 -==== **External Link**: Provide the URL directly. ====
78 -
79 79  {{code}}
80 -[https://www.example.com]
132 +__italic text__
81 81  {{/code}}
82 82  
83 -(((
84 -=== ===
135 +
136 +*
137 +** (((
138 +=== **Underline**: Enclose text with double tildes. ===
85 85  )))
86 86  
141 +{{code}}
142 +~~underlined text~~
143 +{{/code}}
87 87  
88 -== ==
89 89  
90 -== ⚡ **Using the / Macro Shortcut** ==
146 +*
147 +** (((
148 +=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 +)))
91 91  
92 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
151 +{{code}}
152 +* Item 1
153 +* Item 2
154 +{{/code}}
93 93  
94 -* Simply type / and start typing the macro name or feature you want to add.
95 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
96 -* Example macros include:
97 -** /toc – Table of Contents
98 -** /box – Insert Box Macro
99 -** /gallery – Image Gallery
100 -** /footnote – Add footnotes to your text
101 -** /code – Code blocks for programming snippets
102 102  
103 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
157 +*
158 +** (((
159 +=== **Ordered List**: Start lines with a number followed by a period. ===
160 +)))
104 104  
105 -----
162 +{{code}}
163 +1. First item
164 +2. Second item
165 +{{/code}}
106 106  
107 -## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
108 108  
109 -In this section we will go over many of the common macros used. The source code is how you use the macro editing in Wiki mode. If you are doing standard WYSIWYG edit mode (the default mode you get when you click edit instead of the dropdown), you can call most of these macros by simply typing /thecommand
168 +== **Links** ==
110 110  
111 111  
112 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
113 113  
172 +==== **Internal Link**: Use square brackets with the page name. ====
114 114  
115 115  {{code}}
116 -{{toc/}}
175 +[[PageName]]
117 117  {{/code}}
118 118  
119 119  
120 -== **Gallery Macro** `/gallery` ==
121 121  
122 -{{example}}
123 -{{gallery}}
124 -[[1747262485678-297.png]]
125 -[[image:photo2.jpg]]
126 -{{/gallery}}
127 -{{/example}}
180 +==== **External Link**: Provide the URL directly. ====
128 128  
182 +{{code}}
183 +[https://www.example.com]
184 +{{/code}}
129 129  
130 -== **Alternatively** `/carousel` ==
186 +(((
187 +=== **Images** ===
188 +)))
131 131  
132 -{{example}}
133 -{{carousel/}}
190 +{{code}}
191 + [[image:example.jpg]]
192 +{{/code}}
134 134  
135 -
136 -{{/example}}
137 137  
138 -== **Boilerplate Box** ==
139 -
140 -{{example}}
141 -{{box cssClass="highlight"}}
142 -Insert your highlighted content here.
143 -{{/box}}
144 -{{/example}}
145 -
146 -== ==
147 -
148 -== **Info vs Warning **`/info box` ==
149 -
150 -{{example}}
151 -{{info}}
152 -This is an info box.
153 -{{/info}}
154 -
155 -{{warning}}
156 -This is a warning box.
157 -{{/warning}}
158 -{{/example}}
159 -
160 -== **Footnote Demo** `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
161 -
162 -{{example}}
163 -footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
164 -
165 -{{putFootnotes/}}
166 -{{/example}}
167 -
168 -
169 -== ==
170 -
171 -== **Expandable Summary** `/expandable`  VERY USEFUL MACRO ==
172 -
173 -{{example}}
174 -{{expandable summary="🧠 Study Summary"}}
175 -Key findings go here.
176 -{{/expandable}}
177 -{{/example}}
178 -
179 -== ==
180 -
181 -== 📎 **Attachments and Images** ==
182 -
183 -You can easily upload files and images directly from the WYSIWYG editor:
184 -
185 -**Uploading Attachments:**
186 -
187 -* Click **Edit** to enter the WYSIWYG editor.
188 -* Click on the **Attachment** icon (📎 paperclip icon).
189 -* Drag-and-drop or select your file to upload it instantly.
190 -* Uploaded files will automatically be listed as attachments at the bottom of your page.
191 -
192 -== **Audio Embedding** for attached media its better to use the code sometimes but you can embed media with `/embed content` for external media and `/embed JWPlayer` ==
193 -
194 -{{example}}
195 -{{html}}
196 -<audio controls>
197 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
198 - Your browser does not support the audio element.
199 -</audio>
200 -{{/html}}
201 -{{/example}}
202 -
203 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
204 -
205 -=== **Inserting Images with Enlargable Thumbnails** ===
206 -
207 -1. In the editor, click the **"Insert Image"** icon from the toolbar.
208 -1. Upload or select the image.
209 -1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
210 -
211 -[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
212 -
213 -
214 -
215 -
216 -=== **Alternatively: `~[~[image~:image.png]]`** ===
217 -
218 -{{example}}
219 -[[image:1747262485678-297.png]]
220 -{{/example}}
221 -
222 -
223 -
224 -== ==
225 -
226 -----
227 -
228 228  == **Utilizing XWiki Macros** ==
229 229  
230 230  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
231 231  
232 -== Embed Macro ==
199 +**Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
233 233  
234 -The Embed macro shows external content like YouTube videos.
201 +{{code}}
202 +{{box}}
203 +Your content here.
204 +{{/box}}
205 +{{/code}}
235 235  
236 -{{example}}
237 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
238 -{{/example}}
239 239  
240 -
241 241  === **Info Macro**: Displays an informational message, often used for tips or notes. ===
242 242  
243 243  {{code}}
... ... @@ -247,9 +247,18 @@
247 247  {{/code}}
248 248  
249 249  
250 -== **Code Macro**: Renders code snippets with syntax highlighting. ==
217 +=== **Warning Macro**: Highlights warnings or important notices. ===
251 251  
252 252  {{code}}
220 +{{warning}}
221 +Caution: Proceed with care.
222 +{{/warning}}
223 +{{/code}}
224 +
225 +
226 +=== **Code Macro**: Renders code snippets with syntax highlighting. ===
227 +
228 +{{code}}
253 253  {{code language="python"}}
254 254  def hello_world():
255 255   print("Hello, world!")
... ... @@ -257,89 +257,46 @@
257 257  {{/code}}
258 258  
259 259  
260 -== **Video Macro**: `/video` The Video macro embeds videos. ==
236 +=== **Gallery Macro**: Creates an image gallery from attached images. ===
261 261  
262 -{{example}}
263 -{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
264 -{{/example}}
238 +{{code}}
239 +{{gallery}}
240 +[[image1.jpg]]
241 +[[image2.jpg]]
242 +{{/gallery}}
243 +{{/code}}
265 265  
266 266  
267 -== Example Macro ==
246 +=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
268 268  
269 -The example macro displays the output of a macro or script or anything that you like
248 +{{code}}
249 +{{toc/}}
250 +{{/code}}
270 270  
271 -== Expandable Macro ==
272 272  
273 -The following example demonstrates how to present complex information cleanly using `
253 +=== **Include Macro**: Embeds content from another page. ===
274 274  
275 -{{example}}
276 -{{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
277 -**Source:** *Twin Research and Human Genetics (Cambridge University Press)*
278 -**Date of Publication:** *2013*
279 -**Author(s):** *Thomas J. Bouchard Jr.*
280 -**Title:** *"The Wilson Effect: The Increase in Heritability of IQ With Age"*
281 -**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
282 -**Subject Matter:** *Intelligence, Heritability, Developmental Psychology*
255 +{{code}}
256 +{{include reference="PageName"/}}
257 +{{/code}}
283 283  
284 -{{expandable summary="📊 Key Statistics"}}
285 -1. **General Observations:**
286 - - The study documents how the **heritability of IQ increases with age**, reaching an asymptote at **0.80 by adulthood**.
287 - - Analysis is based on **longitudinal twin and adoption studies**.
288 288  
289 -2. **Subgroup Analysis:**
290 - - Shared environmental influence on IQ **declines with age**, reaching **0.10 in adulthood**.
291 - - Monozygotic twins show **increasing genetic similarity in IQ over time**, while dizygotic twins become **less concordant**.
260 +=== **Display Macro**: Displays the content of another document or an object property. ===
292 292  
293 -3. **Other Significant Data Points:**
294 - - Data from the **Louisville Longitudinal Twin Study and cross-national twin samples** support findings.
295 - - IQ stability over time is **influenced more by genetics than by shared environmental factors**.
296 -{{/expandable}}
262 +{{code}}
263 +{{display reference="PageName"/}}
264 +{{/code}}
297 297  
298 -{{expandable summary="🔬 Findings"}}
299 -1. **Primary Observations:**
300 - - Intelligence heritability **strengthens throughout development**, contrary to early environmental models.
301 - - Shared environmental effects **decrease by late adolescence**, emphasizing **genetic influence in adulthood**.
302 302  
303 -2. **Subgroup Trends:**
304 - - Studies from **Scotland, Netherlands, and the US** show **consistent patterns of increasing heritability with age**.
305 - - Findings hold across **varied socio-economic and educational backgrounds**.
267 +=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
306 306  
307 -3. **Specific Case Analysis:**
308 - - Longitudinal adoption studies show **declining impact of adoptive parental influence on IQ** as children age.
309 - - Cross-sectional twin data confirm **higher IQ correlations for monozygotic twins in adulthood**.
310 -{{/expandable}}
269 +{{code}}
270 +{{velocity}}
271 +#set($greeting = "Hello, $user.name!")
272 +$greeting
273 +{{/velocity}}
274 +{{/code}}
311 311  
312 -{{expandable summary="📝 Critique & Observations"}}
313 -1. **Strengths of the Study:**
314 - - **Robust dataset covering multiple twin and adoption studies over decades**.
315 - - **Clear, replicable trend** demonstrating the increasing role of genetics in intelligence.
276 +== See Also: ==
316 316  
317 -2. **Limitations of the Study:**
318 - - Findings apply primarily to **Western industrialized nations**, limiting generalizability.
319 - - **Lack of neurobiological mechanisms** explaining how genes express their influence over time.
320 -
321 -3. **Suggestions for Improvement:**
322 - - Future research should investigate **gene-environment interactions in cognitive aging**.
323 - - Examine **heritability trends in non-Western populations** to determine cross-cultural consistency.
324 -{{/expandable}}
325 -
326 -{{expandable summary="📌 Relevance to Subproject"}}
327 -- Provides **strong evidence for the genetic basis of intelligence**.
328 -- Highlights the **diminishing role of shared environment in cognitive development**.
329 -- Supports research on **cognitive aging and heritability across the lifespan**.
330 -{{/expandable}}
331 -
332 -{{expandable summary="🔍 Suggestions for Further Exploration"}}
333 -1. Investigate **neurogenetic pathways underlying IQ development**.
334 -2. Examine **how education and socioeconomic factors interact with genetic IQ influences**.
335 -3. Study **heritability trends in aging populations and cognitive decline**.
336 -{{/expandable}}
337 -
338 -{{expandable summary="📄 Download Full Study"}}
339 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
340 -{{/expandable}}
341 -{{/expandable}}
342 -{{/example}}
343 -
344 -
345 -
278 +[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]
1747262485678-297.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.AdminAngriff
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 MB
Content