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 16.1
edited by Ryan C
on 2025/05/14 13:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,204 +1,311 @@
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 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
14 14  
15 -----
17 +== ==
16 16  
17 -== Table of Contents Macro (`/toc`) ==
19 +== πŸ“Ž **Attachments and Images** ==
18 18  
19 -{{expandable summary="πŸ“˜ Table of Contents Macro (`/toc`)"}}
20 -{{example}}
21 -{{toc/}}
22 -{{/example}}
23 -{{/expandable}}
21 +You can easily upload files and images directly from the WYSIWYG editor:
24 24  
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 +
25 25  ----
26 26  
27 -== Gallery Macro (`/gallery`) ==
38 +== ⚑ **Using the / Macro Shortcut** ==
28 28  
29 -{{expandable summary="πŸ–ΌοΈ Gallery Macro (`/gallery`)"}}
30 -{{example}}
31 -{{gallery}}
32 -[[1747262485678-297.png]]
33 -[[image:photo2.jpg]]
34 -{{/gallery}}
35 -{{/example}}
36 -{{/expandable}}
40 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
37 37  
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 +
38 38  ----
39 39  
40 -== Carousel Macro (`/carousel`) ==
55 +== ✏️** Basic Formatting and Links (Quick Guide)** ==
41 41  
42 -{{expandable summary="πŸ“½οΈ Carousel Macro (`/carousel`)"}}
43 -{{example}}
44 -{{carousel/}}
45 -{{/example}}
46 -{{/expandable}}
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.
47 47  
48 48  ----
49 49  
50 -== Box Macro (`/box`) ==
65 +== πŸ” **Useful Tips & Best Practices** ==
51 51  
52 -{{expandable summary="πŸ“¦ Box Macro (`/box`)"}}
53 -{{example}}
54 -{{box cssClass="highlight"}}
55 -Insert your highlighted content here.
56 -{{/box}}
57 -{{/example}}
58 -{{/expandable}}
67 +* **Save drafts frequently:** Press Ctrl+S regularly.
68 +* **Macros** greatly simplify content formattingβ€”use / often.
69 +* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
70 +* **Use minimal formatting** to ensure readability.
59 59  
60 60  ----
61 61  
62 -== Info and Warning Boxes (`/info`, `/warning`) ==
74 += ⚑**Guests can contribute** =
63 63  
64 -{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
65 -{{example}}
66 -{{info}}This is an info box.{{/info}}
76 +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.
77 +1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
78 +1. Leave comments, give suggestions, request features.
67 67  
68 -{{warning}}This is a warning box.{{/warning}}
69 -{{/example}}
70 -{{/expandable}}
80 +== **Content Guidelines** ==
71 71  
72 -----
82 +* 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.
83 +* 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.
73 73  
74 -== Footnotes (`/footnote`, `/put footnotes`) ==
85 +== **Directories and Page URLs** ==
75 75  
76 -{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
77 -{{example}}
78 -This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
87 +* 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.
79 79  
80 -{{putFootnotes/}}
81 -{{/example}}
82 -{{/expandable}}
83 83  
84 -----
85 85  
86 -== Expandable Macro (`/expandable`) ==
91 +== **XWiki Editing Modes** ==
87 87  
88 -{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
89 -{{example}}
90 -{{expandable summary="Click to expand"}}
91 -This content is hidden until clicked.
92 -{{/expandable}}
93 -{{/example}}
94 -{{/expandable}}
93 +XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:ξˆ†
95 95  
96 -----
95 +* **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ξˆξˆ†
96 +* **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.ξˆ†
97 97  
98 -== Embed Macro (`/embed content`) ==
99 +== **Essential Formatting Options** ==
99 99  
100 -{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
101 +To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
102 +
103 +* **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.ξˆ†
104 +
105 +{{code}}
106 + + Heading Level 1
107 + ++ Heading Level 2
108 + +++ Heading Level 3
109 +{{/code}}
110 +
111 +
112 +=== **Text Formatting** ===
113 +
114 +
115 +
116 +*
117 +** (((
118 +=== **Bold**: Surround text with double asterisks. ===
119 +)))
120 +
121 +{{code}}
122 +**bold text**
123 +{{/code}}
124 +
125 +
126 +*
127 +** (((
128 +=== **Italics**: Use double underscores. ===
129 +)))
130 +
131 +{{code}}
132 +__italic text__
133 +{{/code}}
134 +
135 +
136 +*
137 +** (((
138 +=== **Underline**: Enclose text with double tildes. ===
139 +)))
140 +
141 +{{code}}
142 +~~underlined text~~
143 +{{/code}}
144 +
145 +
146 +*
147 +** (((
148 +=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 +)))
150 +
151 +{{code}}
152 +* Item 1
153 +* Item 2
154 +{{/code}}
155 +
156 +
157 +*
158 +** (((
159 +=== **Ordered List**: Start lines with a number followed by a period. ===
160 +)))
161 +
162 +{{code}}
163 +1. First item
164 +2. Second item
165 +{{/code}}
166 +
167 +
168 +== **Links** ==
169 +
170 +
171 +
172 +==== **Internal Link**: Use square brackets with the page name. ====
173 +
174 +{{code}}
175 +[[PageName]]
176 +{{/code}}
177 +
178 +
179 +
180 +==== **External Link**: Provide the URL directly. ====
181 +
182 +{{code}}
183 +[https://www.example.com]
184 +{{/code}}
185 +
186 +(((
187 +=== **Images** ===
188 +)))
189 +
190 +{{code}}
191 + [[image:example.jpg]]
192 +{{/code}}
193 +
194 +
195 +== **Utilizing XWiki Macros** ==
196 +
197 +Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
198 +
199 +== Embed Macro ==
200 +
201 +The Embed macro shows external content like YouTube videos.
202 +
101 101  {{example}}
102 102  {{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
103 103  {{/example}}
104 -{{/expandable}}
105 105  
106 -----
107 107  
108 -== Code Macro (`/code`) ==
208 +=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
109 109  
110 -{{expandable summary="πŸ’» Code Block Macro (`/code`)"}}
210 +{{code}}
211 +{{info}}
212 +This is an informational note.
213 +{{/info}}
214 +{{/code}}
215 +
216 +
217 +== Footnote Macro ==
218 +
219 +The Footnote macro adds footnotes to the page.
220 +
111 111  {{example}}
222 +This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
223 +{{putFootnotes/}}
224 +{{/example}}
225 +
226 +
227 +=== **Code Macro**: Renders code snippets with syntax highlighting. ===
228 +
229 +{{code}}
112 112  {{code language="python"}}
113 113  def hello_world():
114 114   print("Hello, world!")
115 115  {{/code}}
116 -{{/example}}
117 -{{/expandable}}
234 +{{/code}}
118 118  
119 -----
120 120  
121 -== Image Insert (`[[image:...]]`) ==
237 +=== **Gallery Macro**: Creates an image gallery from attached images. ===
122 122  
123 -{{expandable summary="πŸ–ΌοΈ Image Macro (`[[image:filename.jpg]]`)"}}
124 -{{example}}
125 -[[image:1747262485678-297.png]]
126 -{{/example}}
127 -{{/expandable}}
239 +{{code}}
240 +{{gallery}}
241 +[[image1.jpg]]
242 +[[image2.jpg]]
243 +{{/gallery}}
244 +{{/code}}
128 128  
129 -----
130 130  
131 -== Audio Embed (HTML tag or `/embed JWPlayer`) ==
247 +=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
132 132  
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}}
249 +{{code}}
250 +{{toc/}}
251 +{{/code}}
143 143  
144 -----
253 +== Video Macro ==
145 145  
146 -== Video Embed Macro (`/video`) ==
255 +The Video macro embeds videos.
147 147  
148 -{{expandable summary="🎬 Video Macro (`/video`)"}}
149 149  {{example}}
150 150  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
151 151  {{/example}}
152 -{{/expandable}}
153 153  
154 -----
261 +== Expandable Macro ==
262 +The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`.
155 155  
156 -== Full Example: Expandable Study Summary (`/expandable`) ==
157 -
158 -{{expandable summary="πŸ“š Full Use Case – Study Summary Macro (`/expandable`)"}}
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)
265 +
266 +
267 +{{expandable summary="🧠 Study: Survey of Expert Opinion on Intelligence"}}
268 +**Source:** *Intelligence (Elsevier)*
269 +**Date:** *2019*
270 +**Authors:** *Heiner Rindermann, David Becker, Thomas R. Coyle*
271 +**DOI:** [10.1016/j.intell.2019.101406](https://doi.org/10.1016/j.intell.2019.101406)
272 +**Subject:** *Psychology, Intelligence Research*
164 164  
165 165  {{expandable summary="πŸ“Š Key Statistics"}}
166 -- IQ heritability rises to **0.80** by adulthood
167 -- Shared environment drops to **0.10**
275 +- Survey of **102 intelligence experts**
276 +- **90% from Western countries**, **83% male**
277 +- **54% left-liberal**, **24% conservative**
278 +- **50/50 split** on genetic vs environmental causes of Black-White IQ gap
168 168  {{/expandable}}
169 169  
170 170  {{expandable summary="πŸ”¬ Findings"}}
171 -- Genetic influence strengthens over time
172 -- Monozygotic twins’ IQ similarity increases with age
282 +- Support for **g-factor theory**
283 +- Agreement on **heritability of intelligence**
284 +- Political lean: left = environmental, right = genetic causes
173 173  {{/expandable}}
174 174  
175 -{{expandable summary="πŸ“ Critique & Observations"}}
176 -- Strength: Large dataset, longitudinal
177 -- Limitation: Mostly Western countries
287 +{{expandable summary="πŸ“ Critique"}}
288 +- Largest expert survey on intelligence
289 +- **Western-only sample**, possible **self-selection bias**
178 178  {{/expandable}}
179 179  
180 180  {{expandable summary="πŸ“Œ Relevance"}}
181 -- Strong support for genetic IQ theories
182 -- Diminishing environmental influence
293 +- Shows **ideological divide** in science
294 +- Highlights **media vs expert disconnect**
183 183  {{/expandable}}
184 184  
185 -{{expandable summary="πŸ“„ Download"}}
186 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
297 +{{expandable summary="πŸ” Explore More"}}
298 +- Global surveys on intelligence beliefs
299 +- Media analysis follow-up studies
187 187  {{/expandable}}
188 188  
302 +{{expandable summary="πŸ“„ Download"}}
303 +[[Download Study>>attach:10.1016_j.intell.2019.101406.pdf]]
189 189  {{/expandable}}
190 -{{/example}}
191 191  {{/expandable}}
306 +{{/example}}
192 192  
193 -----
194 194  
195 -== Bonus: Boilerplate Example Template ==
309 +== See Also: ==
196 196  
197 -{{expandable summary="πŸ“‹ Example Macro Template (`/example`)"}}
198 -{{example}}
199 -{{example}}
200 -Your macro goes here.
201 -{{/example}}
202 -{{/example}}
203 -{{/expandable}}
204 -
311 +[[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