0 Votes

Changes for page Start here if you're new

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

From version 33.1
edited by Ryan C
on 2025/05/14 15:59
Change comment: There is no comment for this version
To version 13.1
edited by Ryan C
on 2025/03/16 01:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -12,130 +12,10 @@
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  
18 -
19 -== ⚡ **Using the / Macro Shortcut** ==
20 -
21 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
22 -
23 -* Simply type / and start typing the macro name or feature you want to add.
24 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
25 -* Example macros include:
26 -** /toc – Table of Contents
27 -** /box – Insert Box Macro
28 -** /gallery – Image Gallery
29 -** /footnote – Add footnotes to your text
30 -** /code – Code blocks for programming snippets
31 -
32 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
33 -
34 -----
35 -
36 -## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
37 -
38 -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
39 -
40 -
41 -== Gallery Macro `/gallery` ==
42 -
43 -{{example}}
44 -{{gallery}}
45 -[[1747262485678-297.png]]
46 -[[image:photo2.jpg]]
47 -{{/gallery}}
48 -{{/example}}
49 -
50 -
51 -== Alternatively `/carousel` ==
52 -
53 -{{example}}
54 -{{carousel/}}
55 -
56 -
57 -{{/example}}
58 -
59 -== Boilerplate Box ==
60 -
61 -{{example}}
62 -{{box cssClass="highlight"}}
63 -Insert your highlighted content here.
64 -{{/box}}
65 -{{/example}}
66 -
67 -== Velocity Greeting ==
68 -
69 -{{example}}
70 -{{velocity}}
71 -#set($name = "Visitor")
72 -Hello, $name!
73 -{{/velocity}}
74 -{{/example}}
75 -
76 -
77 -== Info vs Warning `/info box` ==
78 -
79 -{{example}}
80 -{{info}}
81 -This is an info box.
82 -{{/info}}
83 -
84 -{{warning}}
85 -This is a warning box.
86 -{{/warning}}
87 -{{/example}}
88 -
89 -== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
90 -
91 -{{example}}
92 -footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
93 -
94 -{{putFootnotes/}}
95 -{{/example}}
96 -
97 -
98 -== Groovy Lookup ==
99 -
100 -{{example}}
101 -{{groovy}}
102 -def now = new Date()
103 -println("Current time: " + now)
104 -{{/groovy}}
105 -{{/example}}
106 -
107 -
108 -== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
109 -
110 -{{example}}
111 -{{expandable summary="🧠 Study Summary"}}
112 -Key findings go here.
113 -{{/expandable}}
114 -{{/example}}
115 -
116 -== List Formatting ==
117 -
118 -{{example}}
119 -*Bad formatting*
120 -
121 -* use - inconsistently
122 -** Good formatting:
123 -* Consistent bullet style
124 -* Indented items properly
125 -{{/example}}
126 -
127 -== Python Code ==
128 -
129 -{{example}}
130 -{{code language="python"}}
131 -def greet():
132 - print("Hello World")
133 -{{/code}}
134 -{{/example}}
135 -
136 -== ==
137 -
138 -
139 139  == 📎 **Attachments and Images** ==
140 140  
141 141  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -147,19 +147,6 @@
147 147  * Drag-and-drop or select your file to upload it instantly.
148 148  * Uploaded files will automatically be listed as attachments at the bottom of your page.
149 149  
150 -== 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` ==
151 -
152 -{{example}}
153 -{{html}}
154 -<audio controls>
155 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
156 - Your browser does not support the audio element.
157 -</audio>
158 -{{/html}}
159 -{{/example}}
160 -
161 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
162 -
163 163  === **Inserting Images with Enlargable Thumbnails** ===
164 164  
165 165  1. In the editor, click the **"Insert Image"** icon from the toolbar.
... ... @@ -166,27 +166,25 @@
166 166  1. Upload or select the image.
167 167  1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
168 168  
169 -[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
36 +----
170 170  
38 +== ⚡ **Using the / Macro Shortcut** ==
171 171  
40 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
172 172  
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
173 173  
174 -=== **You can also use this format to insert images** ===
51 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
175 175  
176 -{{example}}
177 -[[image:1747262485678-297.png]]
178 -{{/example}}
53 +----
179 179  
180 -
181 -
182 -
183 -{{code}}
184 - [[image:example.jpg]]
185 -{{/code}}
186 -
187 -
188 -
189 -
190 190  == ✏️** Basic Formatting and Links (Quick Guide)** ==
191 191  
192 192  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
... ... @@ -229,7 +229,12 @@
229 229  
230 230  * **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
231 231  * **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.
232 232  
99 +=== **Switching Between Syntaxes** ===
100 +
101 +XWiki supports multiple syntaxes, including XWiki 2.1, MediaWiki, and others. While it’s possible to switch a page’s syntax, exercise caution, as certain syntaxes may not fully support WYSIWYG editing. For instance, changing a page to MediaWiki syntax might limit the availability of the WYSIWYG editor. citeturn0search6
102 +
233 233  == **Essential Formatting Options** ==
234 234  
235 235  To ensure content is both engaging and accessible, utilize the following formatting techniques:
... ... @@ -243,6 +243,62 @@
243 243  {{/code}}
244 244  
245 245  
116 +=== **Text Formatting** ===
117 +
118 +
119 +
120 +*
121 +** (((
122 +=== **Bold**: Surround text with double asterisks. ===
123 +)))
124 +
125 +{{code}}
126 +**bold text**
127 +{{/code}}
128 +
129 +
130 +*
131 +** (((
132 +=== **Italics**: Use double underscores. ===
133 +)))
134 +
135 +{{code}}
136 +__italic text__
137 +{{/code}}
138 +
139 +
140 +*
141 +** (((
142 +=== **Underline**: Enclose text with double tildes. ===
143 +)))
144 +
145 +{{code}}
146 +~~underlined text~~
147 +{{/code}}
148 +
149 +
150 +*
151 +** (((
152 +=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
153 +)))
154 +
155 +{{code}}
156 +* Item 1
157 +* Item 2
158 +{{/code}}
159 +
160 +
161 +*
162 +** (((
163 +=== **Ordered List**: Start lines with a number followed by a period. ===
164 +)))
165 +
166 +{{code}}
167 +1. First item
168 +2. Second item
169 +{{/code}}
170 +
171 +
246 246  == **Links** ==
247 247  
248 248  
... ... @@ -262,22 +262,27 @@
262 262  {{/code}}
263 263  
264 264  (((
265 -=== ===
191 +=== **Images** ===
266 266  )))
267 267  
194 +{{code}}
195 + [[image:example.jpg]]
196 +{{/code}}
197 +
198 +
268 268  == **Utilizing XWiki Macros** ==
269 269  
270 270  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
271 271  
272 -== Embed Macro ==
203 +**Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
273 273  
274 -The Embed macro shows external content like YouTube videos.
205 +{{code}}
206 +{{box}}
207 +Your content here.
208 +{{/box}}
209 +{{/code}}
275 275  
276 -{{example}}
277 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
278 -{{/example}}
279 279  
280 -
281 281  === **Info Macro**: Displays an informational message, often used for tips or notes. ===
282 282  
283 283  {{code}}
... ... @@ -287,16 +287,15 @@
287 287  {{/code}}
288 288  
289 289  
290 -== Footnote Macro ==
221 +=== **Warning Macro**: Highlights warnings or important notices. ===
291 291  
292 -The Footnote macro adds footnotes to the page.
223 +{{code}}
224 +{{warning}}
225 +Caution: Proceed with care.
226 +{{/warning}}
227 +{{/code}}
293 293  
294 -{{example}}
295 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
296 -{{putFootnotes/}}
297 -{{/example}}
298 298  
299 -
300 300  === **Code Macro**: Renders code snippets with syntax highlighting. ===
301 301  
302 302  {{code}}
... ... @@ -323,91 +323,30 @@
323 323  {{toc/}}
324 324  {{/code}}
325 325  
326 -== Video Macro ==
327 327  
328 -The Video macro embeds videos.
257 +=== **Include Macro**: Embeds content from another page. ===
329 329  
330 -{{example}}
331 -{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
332 -{{/example}}
259 +{{code}}
260 +{{include reference="PageName"/}}
261 +{{/code}}
333 333  
334 334  
335 -== Example Macro ==
264 +=== **Display Macro**: Displays the content of another document or an object property. ===
336 336  
337 -The example macro displays the output of a macro or script or anything that you like
266 +{{code}}
267 +{{display reference="PageName"/}}
268 +{{/code}}
338 338  
339 -== Expandable Macro ==
340 340  
341 -The following example demonstrates how to present complex information cleanly using `
271 +=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
342 342  
343 -{{example}}
344 -{{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
345 -**Source:** *Twin Research and Human Genetics (Cambridge University Press)*
346 -**Date of Publication:** *2013*
347 -**Author(s):** *Thomas J. Bouchard Jr.*
348 -**Title:** *"The Wilson Effect: The Increase in Heritability of IQ With Age"*
349 -**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
350 -**Subject Matter:** *Intelligence, Heritability, Developmental Psychology*
273 +{{code}}
274 +{{velocity}}
275 +#set($greeting = "Hello, $user.name!")
276 +$greeting
277 +{{/velocity}}
278 +{{/code}}
351 351  
352 -{{expandable summary="📊 Key Statistics"}}
353 -1. **General Observations:**
354 - - The study documents how the **heritability of IQ increases with age**, reaching an asymptote at **0.80 by adulthood**.
355 - - Analysis is based on **longitudinal twin and adoption studies**.
280 +== See Also: ==
356 356  
357 -2. **Subgroup Analysis:**
358 - - Shared environmental influence on IQ **declines with age**, reaching **0.10 in adulthood**.
359 - - Monozygotic twins show **increasing genetic similarity in IQ over time**, while dizygotic twins become **less concordant**.
360 -
361 -3. **Other Significant Data Points:**
362 - - Data from the **Louisville Longitudinal Twin Study and cross-national twin samples** support findings.
363 - - IQ stability over time is **influenced more by genetics than by shared environmental factors**.
364 -{{/expandable}}
365 -
366 -{{expandable summary="🔬 Findings"}}
367 -1. **Primary Observations:**
368 - - Intelligence heritability **strengthens throughout development**, contrary to early environmental models.
369 - - Shared environmental effects **decrease by late adolescence**, emphasizing **genetic influence in adulthood**.
370 -
371 -2. **Subgroup Trends:**
372 - - Studies from **Scotland, Netherlands, and the US** show **consistent patterns of increasing heritability with age**.
373 - - Findings hold across **varied socio-economic and educational backgrounds**.
374 -
375 -3. **Specific Case Analysis:**
376 - - Longitudinal adoption studies show **declining impact of adoptive parental influence on IQ** as children age.
377 - - Cross-sectional twin data confirm **higher IQ correlations for monozygotic twins in adulthood**.
378 -{{/expandable}}
379 -
380 -{{expandable summary="📝 Critique & Observations"}}
381 -1. **Strengths of the Study:**
382 - - **Robust dataset covering multiple twin and adoption studies over decades**.
383 - - **Clear, replicable trend** demonstrating the increasing role of genetics in intelligence.
384 -
385 -2. **Limitations of the Study:**
386 - - Findings apply primarily to **Western industrialized nations**, limiting generalizability.
387 - - **Lack of neurobiological mechanisms** explaining how genes express their influence over time.
388 -
389 -3. **Suggestions for Improvement:**
390 - - Future research should investigate **gene-environment interactions in cognitive aging**.
391 - - Examine **heritability trends in non-Western populations** to determine cross-cultural consistency.
392 -{{/expandable}}
393 -
394 -{{expandable summary="📌 Relevance to Subproject"}}
395 -- Provides **strong evidence for the genetic basis of intelligence**.
396 -- Highlights the **diminishing role of shared environment in cognitive development**.
397 -- Supports research on **cognitive aging and heritability across the lifespan**.
398 -{{/expandable}}
399 -
400 -{{expandable summary="🔍 Suggestions for Further Exploration"}}
401 -1. Investigate **neurogenetic pathways underlying IQ development**.
402 -2. Examine **how education and socioeconomic factors interact with genetic IQ influences**.
403 -3. Study **heritability trends in aging populations and cognitive decline**.
404 -{{/expandable}}
405 -
406 -{{expandable summary="📄 Download Full Study"}}
407 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
408 -{{/expandable}}
409 -{{/expandable}}
410 -{{/example}}
411 -
412 -
413 -
282 +[[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