0 Votes

Changes for page Start here if you're new

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

From version 23.1
edited by Ryan C
on 2025/05/14 15:33
Change comment: There is no comment for this version
To version 35.1
edited by Ryan C
on 2025/05/14 16:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,441 +1,204 @@
1 -= =
1 += πŸ“š Macro Examples & Formatting Guide =
2 2  
3 3  ----
4 4  
5 -== ==
5 +== πŸ“– Table of Contents ==
6 6  
7 -== πŸ“– Table of Contents: ==
8 -
9 9  {{toc/}}
10 10  
11 11  ----
12 12  
13 -== Getting Started with XWiki ==
11 +== πŸ§ͺ Macro Showcase: Source + Output + Slash Command ==
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**:
13 +All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
16 16  
17 ----
15 +----
18 18  
19 -## πŸ§ͺ 1. **Macro Showcase: Source-to-Output Toggle**
17 +== Table of Contents Macro (`/toc`) ==
20 20  
21 -Show how a macro works without cluttering the page with raw syntax.
19 +{{expandable summary="πŸ“˜ Table of Contents Macro (`/toc`)"}}
20 +{{example}}
21 +{{toc/}}
22 +{{/example}}
23 +{{/expandable}}
22 22  
25 +----
23 23  
24 -== Gallery Macro ==
27 +== Gallery Macro (`/gallery`) ==
25 25  
29 +{{expandable summary="πŸ–ΌοΈ Gallery Macro (`/gallery`)"}}
26 26  {{example}}
27 -
28 28  {{gallery}}
29 -[[image:photo1.jpg]]
32 +[[1747262485678-297.png]]
30 30  [[image:photo2.jpg]]
31 31  {{/gallery}}
35 +{{/example}}
36 +{{/expandable}}
32 32  
38 +----
39 +
40 +== Carousel Macro (`/carousel`) ==
41 +
42 +{{expandable summary="πŸ“½οΈ Carousel Macro (`/carousel`)"}}
43 +{{example}}
44 +{{carousel/}}
33 33  {{/example}}
46 +{{/expandable}}
34 34  
48 +----
35 35  
36 -== Boilerplate Box ==
50 +== Box Macro (`/box`) ==
51 +
52 +{{expandable summary="πŸ“¦ Box Macro (`/box`)"}}
37 37  {{example}}
38 38  {{box cssClass="highlight"}}
39 39  Insert your highlighted content here.
40 40  {{/box}}
41 41  {{/example}}
58 +{{/expandable}}
42 42  
43 -== Velocity Greeting ==
44 -{{example}}
45 -{{velocity}}
46 -#set($name = "Visitor")
47 -Hello, $name!
48 -{{/velocity}}
49 -{{/example}}
60 +----
50 50  
62 +== Info and Warning Boxes (`/info`, `/warning`) ==
51 51  
52 -== Info vs Warning ==
64 +{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
53 53  {{example}}
54 54  {{info}}This is an info box.{{/info}}
55 55  
56 56  {{warning}}This is a warning box.{{/warning}}
57 57  {{/example}}
70 +{{/expandable}}
58 58  
59 -== Footnote Demo ==
60 -{{example}}
61 -This claim needs a source{{footnote}}Here it is.{{/footnote}}.
62 -{{putFootnotes/}}
63 -{{/example}}
72 +----
64 64  
65 -== Groovy Lookup ==
66 -{{example}}
67 -{{groovy}}
68 -def now = new Date()
69 -println("Current time: " + now)
70 -{{/groovy}}
71 -{{/example}}
74 +== Footnotes (`/footnote`, `/put footnotes`) ==
72 72  
73 -
74 -== Access Current User ==
76 +{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
75 75  {{example}}
76 -{{velocity}}
77 -Current user: **$xcontext.user**
78 -{{/velocity}}
79 -{{/example}}
78 +This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
80 80  
81 -
82 -== Expandable Summary ==
83 -{{example}}
84 -{{expandable summary="🧠 Study Summary"}}
85 -Key findings go here.
86 -{{/expandable}}
80 +{{putFootnotes/}}
87 87  {{/example}}
82 +{{/expandable}}
88 88  
89 -== List Formatting ==
90 -{{example}}
91 -*Bad formatting*
92 -* use - inconsistently
93 -** Good formatting:
94 - * Consistent bullet style
95 - * Indented items properly
96 -{{/example}}
84 +----
97 97  
98 -== Python Code ==
99 -{{example}}
100 -{{code language="python"}}
101 -def greet():
102 - print("Hello World")
103 -{{/code}}
104 -{{/example}}
86 +== Expandable Macro (`/expandable`) ==
105 105  
106 -== Audio Embedding ==
88 +{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
107 107  {{example}}
108 -{{html}}
109 -<audio controls>
110 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
111 - Your browser does not support the audio element.
112 -</audio>
113 -{{/html}}
90 +{{expandable summary="Click to expand"}}
91 +This content is hidden until clicked.
92 +{{/expandable}}
114 114  {{/example}}
115 -
116 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
94 +{{/expandable}}
117 117  
118 -== ==
119 -
120 -== πŸ“Ž **Attachments and Images** ==
121 -
122 -You can easily upload files and images directly from the WYSIWYG editor:
123 -
124 -**Uploading Attachments:**
125 -
126 -* Click **Edit** to enter the WYSIWYG editor.
127 -* Click on the **Attachment** icon (πŸ“Ž paperclip icon).
128 -* Drag-and-drop or select your file to upload it instantly.
129 -* Uploaded files will automatically be listed as attachments at the bottom of your page.
130 -
131 -=== **Inserting Images with Enlargable Thumbnails** ===
132 -
133 -1. In the editor, click the **"Insert Image"** icon from the toolbar.
134 -1. Upload or select the image.
135 -1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
136 -
137 137  ----
138 138  
139 -== ⚑ **Using the / Macro Shortcut** ==
98 +== Embed Macro (`/embed content`) ==
140 140  
141 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
142 -
143 -* Simply type / and start typing the macro name or feature you want to add.
144 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
145 -* Example macros include:
146 -** /toc – Table of Contents
147 -** /box – Insert Box Macro
148 -** /gallery – Image Gallery
149 -** /footnote – Add footnotes to your text
150 -** /code – Code blocks for programming snippets
151 -
152 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
153 -
154 -----
155 -
156 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
157 -
158 -* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
159 -* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
160 -* **Creating Links**:
161 -** Highlight text and click **"Link"** or use shortcut Ctrl+K.
162 -** Paste or select the page URL to link internally.
163 -
164 -----
165 -
166 -== πŸ” **Useful Tips & Best Practices** ==
167 -
168 -* **Save drafts frequently:** Press Ctrl+S regularly.
169 -* **Macros** greatly simplify content formattingβ€”use / often.
170 -* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
171 -* **Use minimal formatting** to ensure readability.
172 -
173 -----
174 -
175 -= ⚑**Guests can contribute** =
176 -
177 -1. Guests can edit pages in the main content area without signing up. If this becomes problematic I'll change it but for now I'd like everyone to have access with as little trouble as possible.
178 -1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
179 -1. Leave comments, give suggestions, request features.
180 -
181 -== **Content Guidelines** ==
182 -
183 -* Ensure your content is well-researched, you don't need to include references in the format of footnotes for your material, but you should try to include studies or links to give credibility to your claims. For instance, just claiming that [[IQ is genetic>>doc:Main Categories.Science & Research.Race & IQ.WebHome]] is genetic wouldn't be valid unless you provide a study backing up that assertion, or more likely link to a page within this site that explains why IQ is not something that is purely determined by environmental factors. If such a page doesn't exist, create it, and start providing studies that show this.
184 -* Use clear, concise language and avoid using slurs, slang, or troll like language. This isn't supposed to be encyclopedia dramatica, I'd like things to remain relatively mature and well thought out.
185 -
186 -== **Directories and Page URLs** ==
187 -
188 -* The categories I have made up should cover most content, but if you feel your content doesn't fit under them, feel free to make a new category. Moving pages and reorganizing content in this wiki is very easy.
189 -
190 -
191 -
192 -== **XWiki Editing Modes** ==
193 -
194 -XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:ξˆ†
195 -
196 -* **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ξˆξˆ†
197 -* **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.ξˆ†
198 -* **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.ξˆ†
199 -
200 -== **Essential Formatting Options** ==
201 -
202 -To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
203 -
204 -* **Headings**: Organize content hierarchically using headings. In XWiki syntax, headings are defined by one to six plus signs (+), corresponding to heading levels 1 to 6.ξˆ†
205 -
206 -{{code}}
207 - + Heading Level 1
208 - ++ Heading Level 2
209 - +++ Heading Level 3
210 -{{/code}}
211 -
212 -
213 -=== **Text Formatting** ===
214 -
215 -
216 -
217 -*
218 -** (((
219 -=== **Bold**: Surround text with double asterisks. ===
220 -)))
221 -
222 -{{code}}
223 -**bold text**
224 -{{/code}}
225 -
226 -
227 -*
228 -** (((
229 -=== **Italics**: Use double underscores. ===
230 -)))
231 -
232 -{{code}}
233 -__italic text__
234 -{{/code}}
235 -
236 -
237 -*
238 -** (((
239 -=== **Underline**: Enclose text with double tildes. ===
240 -)))
241 -
242 -{{code}}
243 -~~underlined text~~
244 -{{/code}}
245 -
246 -
247 -*
248 -** (((
249 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
250 -)))
251 -
252 -{{code}}
253 -* Item 1
254 -* Item 2
255 -{{/code}}
256 -
257 -
258 -*
259 -** (((
260 -=== **Ordered List**: Start lines with a number followed by a period. ===
261 -)))
262 -
263 -{{code}}
264 -1. First item
265 -2. Second item
266 -{{/code}}
267 -
268 -
269 -== **Links** ==
270 -
271 -
272 -
273 -==== **Internal Link**: Use square brackets with the page name. ====
274 -
275 -{{code}}
276 -[[PageName]]
277 -{{/code}}
278 -
279 -
280 -
281 -==== **External Link**: Provide the URL directly. ====
282 -
283 -{{code}}
284 -[https://www.example.com]
285 -{{/code}}
286 -
287 -(((
288 -=== **Images** ===
289 -)))
290 -
291 -{{code}}
292 - [[image:example.jpg]]
293 -{{/code}}
294 -
295 -
296 -== **Utilizing XWiki Macros** ==
297 -
298 -Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
299 -
300 -== Embed Macro ==
301 -
302 -The Embed macro shows external content like YouTube videos.
303 -
100 +{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
304 304  {{example}}
305 305  {{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
306 306  {{/example}}
104 +{{/expandable}}
307 307  
106 +----
308 308  
309 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
108 +== Code Macro (`/code`) ==
310 310  
311 -{{code}}
312 -{{info}}
313 -This is an informational note.
314 -{{/info}}
315 -{{/code}}
316 -
317 -
318 -== Footnote Macro ==
319 -
320 -The Footnote macro adds footnotes to the page.
321 -
110 +{{expandable summary="πŸ’» Code Block Macro (`/code`)"}}
322 322  {{example}}
323 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
324 -{{putFootnotes/}}
325 -{{/example}}
326 -
327 -
328 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
329 -
330 -{{code}}
331 331  {{code language="python"}}
332 332  def hello_world():
333 333   print("Hello, world!")
334 334  {{/code}}
335 -{{/code}}
116 +{{/example}}
117 +{{/expandable}}
336 336  
119 +----
337 337  
338 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
121 +== Image Insert (`[[image:...]]`) ==
339 339  
340 -{{code}}
341 -{{gallery}}
342 -[[image1.jpg]]
343 -[[image2.jpg]]
344 -{{/gallery}}
345 -{{/code}}
123 +{{expandable summary="πŸ–ΌοΈ Image Macro (`[[image:filename.jpg]]`)"}}
124 +{{example}}
125 +[[image:1747262485678-297.png]]
126 +{{/example}}
127 +{{/expandable}}
346 346  
129 +----
347 347  
348 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
131 +== Audio Embed (HTML tag or `/embed JWPlayer`) ==
349 349  
350 -{{code}}
351 -{{toc/}}
352 -{{/code}}
133 +{{expandable summary="πŸ”Š Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
134 +{{example}}
135 +{{html}}
136 +<audio controls>
137 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
138 + Your browser does not support the audio element.
139 +</audio>
140 +{{/html}}
141 +{{/example}}
142 +{{/expandable}}
353 353  
354 -== Video Macro ==
144 +----
355 355  
356 -The Video macro embeds videos.
146 +== Video Embed Macro (`/video`) ==
357 357  
148 +{{expandable summary="🎬 Video Macro (`/video`)"}}
358 358  {{example}}
359 359  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
360 360  {{/example}}
152 +{{/expandable}}
361 361  
154 +----
362 362  
363 -== Example Macro ==
156 +== Full Example: Expandable Study Summary (`/expandable`) ==
364 364  
365 -The example macro displays the output of a macro or script or anything that you like
366 -== Expandable Macro ==
367 -
368 -The following example demonstrates how to present complex information cleanly using `
369 -
158 +{{expandable summary="πŸ“š Full Use Case – Study Summary Macro (`/expandable`)"}}
370 370  {{example}}
160 +{{expandable summary="Study: The Wilson Effect"}}
161 +**Source:** *Twin Research and Human Genetics (2013)*
162 +**Author:** *Thomas J. Bouchard Jr.*
163 +**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
371 371  
372 -{{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
373 -**Source:** *Twin Research and Human Genetics (Cambridge University Press)*
374 -**Date of Publication:** *2013*
375 -**Author(s):** *Thomas J. Bouchard Jr.*
376 -**Title:** *"The Wilson Effect: The Increase in Heritability of IQ With Age"*
377 -**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
378 -**Subject Matter:** *Intelligence, Heritability, Developmental Psychology*
379 -
380 380  {{expandable summary="πŸ“Š Key Statistics"}}
381 -1. **General Observations:**
382 - - The study documents how the **heritability of IQ increases with age**, reaching an asymptote at **0.80 by adulthood**.
383 - - Analysis is based on **longitudinal twin and adoption studies**.
384 -
385 -2. **Subgroup Analysis:**
386 - - Shared environmental influence on IQ **declines with age**, reaching **0.10 in adulthood**.
387 - - Monozygotic twins show **increasing genetic similarity in IQ over time**, while dizygotic twins become **less concordant**.
388 -
389 -3. **Other Significant Data Points:**
390 - - Data from the **Louisville Longitudinal Twin Study and cross-national twin samples** support findings.
391 - - IQ stability over time is **influenced more by genetics than by shared environmental factors**.
166 +- IQ heritability rises to **0.80** by adulthood
167 +- Shared environment drops to **0.10**
392 392  {{/expandable}}
393 393  
394 394  {{expandable summary="πŸ”¬ Findings"}}
395 -1. **Primary Observations:**
396 - - Intelligence heritability **strengthens throughout development**, contrary to early environmental models.
397 - - Shared environmental effects **decrease by late adolescence**, emphasizing **genetic influence in adulthood**.
398 -
399 -2. **Subgroup Trends:**
400 - - Studies from **Scotland, Netherlands, and the US** show **consistent patterns of increasing heritability with age**.
401 - - Findings hold across **varied socio-economic and educational backgrounds**.
402 -
403 -3. **Specific Case Analysis:**
404 - - Longitudinal adoption studies show **declining impact of adoptive parental influence on IQ** as children age.
405 - - Cross-sectional twin data confirm **higher IQ correlations for monozygotic twins in adulthood**.
171 +- Genetic influence strengthens over time
172 +- Monozygotic twins’ IQ similarity increases with age
406 406  {{/expandable}}
407 407  
408 408  {{expandable summary="πŸ“ Critique & Observations"}}
409 -1. **Strengths of the Study:**
410 - - **Robust dataset covering multiple twin and adoption studies over decades**.
411 - - **Clear, replicable trend** demonstrating the increasing role of genetics in intelligence.
412 -
413 -2. **Limitations of the Study:**
414 - - Findings apply primarily to **Western industrialized nations**, limiting generalizability.
415 - - **Lack of neurobiological mechanisms** explaining how genes express their influence over time.
416 -
417 -3. **Suggestions for Improvement:**
418 - - Future research should investigate **gene-environment interactions in cognitive aging**.
419 - - Examine **heritability trends in non-Western populations** to determine cross-cultural consistency.
176 +- Strength: Large dataset, longitudinal
177 +- Limitation: Mostly Western countries
420 420  {{/expandable}}
421 421  
422 -{{expandable summary="πŸ“Œ Relevance to Subproject"}}
423 -- Provides **strong evidence for the genetic basis of intelligence**.
424 -- Highlights the **diminishing role of shared environment in cognitive development**.
425 -- Supports research on **cognitive aging and heritability across the lifespan**.
180 +{{expandable summary="πŸ“Œ Relevance"}}
181 +- Strong support for genetic IQ theories
182 +- Diminishing environmental influence
426 426  {{/expandable}}
427 427  
428 -{{expandable summary="πŸ” Suggestions for Further Exploration"}}
429 -1. Investigate **neurogenetic pathways underlying IQ development**.
430 -2. Examine **how education and socioeconomic factors interact with genetic IQ influences**.
431 -3. Study **heritability trends in aging populations and cognitive decline**.
185 +{{expandable summary="πŸ“„ Download"}}
186 +[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
432 432  {{/expandable}}
433 433  
434 -{{expandable summary="πŸ“„ Download Full Study"}}
435 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
436 436  {{/expandable}}
437 -{{/expandable}}
438 438  {{/example}}
191 +{{/expandable}}
439 439  
193 +----
440 440  
195 +== Bonus: Boilerplate Example Template ==
441 441  
197 +{{expandable summary="πŸ“‹ Example Macro Template (`/example`)"}}
198 +{{example}}
199 +{{example}}
200 +Your macro goes here.
201 +{{/example}}
202 +{{/example}}
203 +{{/expandable}}
204 +
1747262485678-297.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.AdminAngriff
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 MB
Content