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 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,45 +1,32 @@
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  
15 +----
17 17  
17 +== Table of Contents Macro (`/toc`) ==
18 18  
19 -== ⚡ **Using the / Macro Shortcut** ==
19 +{{expandable summary="📘 Table of Contents Macro (`/toc`)"}}
20 +{{example}}
21 +{{toc/}}
22 +{{/example}}
23 +{{/expandable}}
20 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 34  ----
35 35  
36 -## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
27 +== Gallery Macro (`/gallery`) ==
37 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 -
29 +{{expandable summary="🖼️ Gallery Macro (`/gallery`)"}}
43 43  {{example}}
44 44  {{gallery}}
45 45  [[1747262485678-297.png]]
... ... @@ -46,109 +46,104 @@
46 46  [[image:photo2.jpg]]
47 47  {{/gallery}}
48 48  {{/example}}
36 +{{/expandable}}
49 49  
38 +----
50 50  
51 -== Alternatively `/carousel` ==
40 +== Carousel Macro (`/carousel`) ==
52 52  
42 +{{expandable summary="📽️ Carousel Macro (`/carousel`)"}}
53 53  {{example}}
54 54  {{carousel/}}
55 -
56 -
57 57  {{/example}}
46 +{{/expandable}}
58 58  
59 -== Boilerplate Box ==
48 +----
60 60  
50 +== Box Macro (`/box`) ==
51 +
52 +{{expandable summary="📦 Box Macro (`/box`)"}}
61 61  {{example}}
62 62  {{box cssClass="highlight"}}
63 63  Insert your highlighted content here.
64 64  {{/box}}
65 65  {{/example}}
58 +{{/expandable}}
66 66  
67 -== Velocity Greeting ==
60 +----
68 68  
69 -{{example}}
70 -{{velocity}}
71 -#set($name = "Visitor")
72 -Hello, $name!
73 -{{/velocity}}
74 -{{/example}}
62 +== Info and Warning Boxes (`/info`, `/warning`) ==
75 75  
76 -
77 -== Info vs Warning `/info box` ==
78 -
64 +{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
79 79  {{example}}
80 -{{info}}
81 -This is an info box.
82 -{{/info}}
66 +{{info}}This is an info box.{{/info}}
83 83  
84 -{{warning}}
85 -This is a warning box.
86 -{{/warning}}
68 +{{warning}}This is a warning box.{{/warning}}
87 87  {{/example}}
70 +{{/expandable}}
88 88  
89 -== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
72 +----
90 90  
74 +== Footnotes (`/footnote`, `/put footnotes`) ==
75 +
76 +{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
91 91  {{example}}
92 -footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
78 +This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
93 93  
94 94  {{putFootnotes/}}
95 95  {{/example}}
82 +{{/expandable}}
96 96  
84 +----
97 97  
98 -== Groovy Lookup ==
86 +== Expandable Macro (`/expandable`) ==
99 99  
88 +{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
100 100  {{example}}
101 -{{groovy}}
102 -def now = new Date()
103 -println("Current time: " + now)
104 -{{/groovy}}
90 +{{expandable summary="Click to expand"}}
91 +This content is hidden until clicked.
92 +{{/expandable}}
105 105  {{/example}}
94 +{{/expandable}}
106 106  
96 +----
107 107  
108 -== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
98 +== Embed Macro (`/embed content`) ==
109 109  
100 +{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
110 110  {{example}}
111 -{{expandable summary="🧠 Study Summary"}}
112 -Key findings go here.
113 -{{/expandable}}
102 +{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
114 114  {{/example}}
104 +{{/expandable}}
115 115  
116 -== List Formatting ==
106 +----
117 117  
118 -{{example}}
119 -*Bad formatting*
108 +== Code Macro (`/code`) ==
120 120  
121 -* use - inconsistently
122 -** Good formatting:
123 -* Consistent bullet style
124 -* Indented items properly
125 -{{/example}}
126 -
127 -== Python Code ==
128 -
110 +{{expandable summary="💻 Code Block Macro (`/code`)"}}
129 129  {{example}}
130 130  {{code language="python"}}
131 -def greet():
132 - print("Hello World")
113 +def hello_world():
114 + print("Hello, world!")
133 133  {{/code}}
134 134  {{/example}}
117 +{{/expandable}}
135 135  
136 -== ==
119 +----
137 137  
121 +== Image Insert (`[[image:...]]`) ==
138 138  
139 -== 📎 **Attachments and Images** ==
123 +{{expandable summary="🖼️ Image Macro (`[[image:filename.jpg]]`)"}}
124 +{{example}}
125 +[[image:1747262485678-297.png]]
126 +{{/example}}
127 +{{/expandable}}
140 140  
141 -You can easily upload files and images directly from the WYSIWYG editor:
129 +----
142 142  
143 -**Uploading Attachments:**
131 +== Audio Embed (HTML tag or `/embed JWPlayer`) ==
144 144  
145 -* Click **Edit** to enter the WYSIWYG editor.
146 -* Click on the **Attachment** icon (📎 paperclip icon).
147 -* Drag-and-drop or select your file to upload it instantly.
148 -* Uploaded files will automatically be listed as attachments at the bottom of your page.
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 -
133 +{{expandable summary="🔊 Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
152 152  {{example}}
153 153  {{html}}
154 154  <audio controls>
... ... @@ -157,257 +157,66 @@
157 157  </audio>
158 158  {{/html}}
159 159  {{/example}}
142 +{{/expandable}}
160 160  
161 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
162 -
163 -=== **Inserting Images with Enlargable Thumbnails** ===
164 -
165 -1. In the editor, click the **"Insert Image"** icon from the toolbar.
166 -1. Upload or select the image.
167 -1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
168 -
169 -[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
170 -
171 -
172 -
173 -
174 -=== **You can also use this format to insert images** ===
175 -
176 -{{example}}
177 -[[image:1747262485678-297.png]]
178 -{{/example}}
179 -
180 -
181 -
182 -
183 -{{code}}
184 - [[image:example.jpg]]
185 -{{/code}}
186 -
187 -
188 -
189 -
190 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
191 -
192 -* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
193 -* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
194 -* **Creating Links**:
195 -** Highlight text and click **"Link"** or use shortcut Ctrl+K.
196 -** Paste or select the page URL to link internally.
197 -
198 198  ----
199 199  
200 -== 🔍 **Useful Tips & Best Practices** ==
146 +== Video Embed Macro (`/video`) ==
201 201  
202 -* **Save drafts frequently:** Press Ctrl+S regularly.
203 -* **Macros** greatly simplify content formatting—use / often.
204 -* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
205 -* **Use minimal formatting** to ensure readability.
206 -
207 -----
208 -
209 -= ⚡**Guests can contribute** =
210 -
211 -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.
212 -1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
213 -1. Leave comments, give suggestions, request features.
214 -
215 -== **Content Guidelines** ==
216 -
217 -* 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.
218 -* 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.
219 -
220 -== **Directories and Page URLs** ==
221 -
222 -* 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.
223 -
224 -
225 -
226 -== **XWiki Editing Modes** ==
227 -
228 -XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
229 -
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 -* **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.
232 -
233 -== **Essential Formatting Options** ==
234 -
235 -To ensure content is both engaging and accessible, utilize the following formatting techniques:
236 -
237 -* **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.
238 -
239 -{{code}}
240 - + Heading Level 1
241 - ++ Heading Level 2
242 - +++ Heading Level 3
243 -{{/code}}
244 -
245 -
246 -== **Links** ==
247 -
248 -
249 -
250 -==== **Internal Link**: Use square brackets with the page name. ====
251 -
252 -{{code}}
253 -[[PageName]]
254 -{{/code}}
255 -
256 -
257 -
258 -==== **External Link**: Provide the URL directly. ====
259 -
260 -{{code}}
261 -[https://www.example.com]
262 -{{/code}}
263 -
264 -(((
265 -=== ===
266 -)))
267 -
268 -== **Utilizing XWiki Macros** ==
269 -
270 -Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
271 -
272 -== Embed Macro ==
273 -
274 -The Embed macro shows external content like YouTube videos.
275 -
148 +{{expandable summary="🎬 Video Macro (`/video`)"}}
276 276  {{example}}
277 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
278 -{{/example}}
279 -
280 -
281 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
282 -
283 -{{code}}
284 -{{info}}
285 -This is an informational note.
286 -{{/info}}
287 -{{/code}}
288 -
289 -
290 -== Footnote Macro ==
291 -
292 -The Footnote macro adds footnotes to the page.
293 -
294 -{{example}}
295 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
296 -{{putFootnotes/}}
297 -{{/example}}
298 -
299 -
300 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
301 -
302 -{{code}}
303 -{{code language="python"}}
304 -def hello_world():
305 - print("Hello, world!")
306 -{{/code}}
307 -{{/code}}
308 -
309 -
310 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
311 -
312 -{{code}}
313 -{{gallery}}
314 -[[image1.jpg]]
315 -[[image2.jpg]]
316 -{{/gallery}}
317 -{{/code}}
318 -
319 -
320 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
321 -
322 -{{code}}
323 -{{toc/}}
324 -{{/code}}
325 -
326 -== Video Macro ==
327 -
328 -The Video macro embeds videos.
329 -
330 -{{example}}
331 331  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
332 332  {{/example}}
152 +{{/expandable}}
333 333  
154 +----
334 334  
335 -== Example Macro ==
156 +== Full Example: Expandable Study Summary (`/expandable`) ==
336 336  
337 -The example macro displays the output of a macro or script or anything that you like
338 -
339 -== Expandable Macro ==
340 -
341 -The following example demonstrates how to present complex information cleanly using `
342 -
158 +{{expandable summary="📚 Full Use Case – Study Summary Macro (`/expandable`)"}}
343 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*
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)
351 351  
352 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**.
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**.
166 +- IQ heritability rises to **0.80** by adulthood
167 +- Shared environment drops to **0.10**
364 364  {{/expandable}}
365 365  
366 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**.
171 +- Genetic influence strengthens over time
172 +- Monozygotic twins’ IQ similarity increases with age
378 378  {{/expandable}}
379 379  
380 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.
176 +- Strength: Large dataset, longitudinal
177 +- Limitation: Mostly Western countries
392 392  {{/expandable}}
393 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**.
180 +{{expandable summary="📌 Relevance"}}
181 +- Strong support for genetic IQ theories
182 +- Diminishing environmental influence
398 398  {{/expandable}}
399 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**.
185 +{{expandable summary="📄 Download"}}
186 +[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
404 404  {{/expandable}}
405 405  
406 -{{expandable summary="📄 Download Full Study"}}
407 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
408 408  {{/expandable}}
409 -{{/expandable}}
410 410  {{/example}}
191 +{{/expandable}}
411 411  
193 +----
412 412  
413 -
195 +== Bonus: Boilerplate Example Template ==
196 +
197 +{{expandable summary="📋 Example Macro Template (`/example`)"}}
198 +{{example}}
199 +{{example}}
200 +Your macro goes here.
201 +{{/example}}
202 +{{/example}}
203 +{{/expandable}}
204 +