Skip to Content
0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/06/28 04:59
From version 35.1
edited by Ryan C
on 2025/05/14 16:18
Change comment: There is no comment for this version
To version 30.1
edited by Ryan C
on 2025/05/14 15:46
Change comment: There is no comment for this version

Summary

Details

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