0 Votes

Changes for page Start here if you're new

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

From version 16.1
edited by Ryan C
on 2025/05/14 13:30
Change comment: There is no comment for this version
To version 6.1
edited by Ryan C
on 2025/03/16 01:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,22 +2,22 @@
2 2  
3 3  ----
4 4  
5 -== ==
5 +== Getting Started with XWiki ==
6 6  
7 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
8 +
7 7  == 📖 Table of Contents: ==
8 8  
9 -{{toc/}}
11 +* [[Editing with the WYSIWYG Editor>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#editing-pages]]
12 +* [[Inserting Attachments and Images>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#attachments]]
13 +* [[Using the / Macro Shortcut>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#macros]]
14 +* [[Basic Formatting and Links>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#formatting]]
15 +* [[Useful Tips>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#tips]]
10 10  
11 11  ----
12 12  
13 -== Getting Started with XWiki ==
19 +== 📎 Attachments and Images ==
14 14  
15 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
16 -
17 -== ==
18 -
19 -== 📎 **Attachments and Images** ==
20 -
21 21  You can easily upload files and images directly from the WYSIWYG editor:
22 22  
23 23  **Uploading Attachments:**
... ... @@ -27,7 +27,7 @@
27 27  * Drag-and-drop or select your file to upload it instantly.
28 28  * Uploaded files will automatically be listed as attachments at the bottom of your page.
29 29  
30 -=== **Inserting Images with Enlargable Thumbnails** ===
30 +=== Inserting Images with Enlargable Thumbnails ===
31 31  
32 32  1. In the editor, click the **"Insert Image"** icon from the toolbar.
33 33  1. Upload or select the image.
... ... @@ -35,7 +35,7 @@
35 35  
36 36  ----
37 37  
38 -== ⚡ **Using the / Macro Shortcut** ==
38 +== ⚡ Using the / Macro Shortcut ==
39 39  
40 40  The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
41 41  
... ... @@ -52,7 +52,7 @@
52 52  
53 53  ----
54 54  
55 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
55 +== ✏️ Basic Formatting and Links (Quick Guide) ==
56 56  
57 57  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
58 58  * **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
... ... @@ -62,7 +62,7 @@
62 62  
63 63  ----
64 64  
65 -== 🔍 **Useful Tips & Best Practices** ==
65 +== 🔍 Useful Tips & Best Practices ==
66 66  
67 67  * **Save drafts frequently:** Press Ctrl+S regularly.
68 68  * **Macros** greatly simplify content formatting—use / often.
... ... @@ -71,37 +71,42 @@
71 71  
72 72  ----
73 73  
74 -= ⚡**Guests can contribute** =
74 += ⚡Guests can contribute =
75 75  
76 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 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 78  1. Leave comments, give suggestions, request features.
79 79  
80 -== **Content Guidelines** ==
80 +== Content Guidelines ==
81 81  
82 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 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.
84 84  
85 -== **Directories and Page URLs** ==
85 +== Directories and Page URLs ==
86 86  
87 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.
88 88  
89 +Here’s a consolidated guide tailored for your XWiki environment, integrating essential syntax, formatting options, and an overview of notable macros to enhance content creation and management.
89 89  
91 +**1. XWiki Editing Modes**
90 90  
91 -== **XWiki Editing Modes** ==
92 -
93 93  XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
94 94  
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.
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.
98 98  
99 -== **Essential Formatting Options** ==
99 +**Switching Between Syntaxes**
100 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 +
103 +**2. Essential Formatting Options**
104 +
101 101  To ensure content is both engaging and accessible, utilize the following formatting techniques:
102 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.
107 +*. **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 104  
109 +
105 105  {{code}}
106 106   + Heading Level 1
107 107   ++ Heading Level 2
... ... @@ -108,104 +108,83 @@
108 108   +++ Heading Level 3
109 109  {{/code}}
110 110  
116 +
111 111  
112 -=== **Text Formatting** ===
118 +*. **Text Formatting**: Apply styles such as bold, italics, and underlining to emphasize text.
113 113  
120 +**. **Bold**: Surround text with double asterisks.
114 114  
115 115  
116 -*
117 -** (((
118 -=== **Bold**: Surround text with double asterisks. ===
119 -)))
120 -
121 121  {{code}}
122 122  **bold text**
123 123  {{/code}}
126 +**. **Italics**: Use double underscores.
124 124  
125 125  
126 -*
127 -** (((
128 -=== **Italics**: Use double underscores. ===
129 -)))
130 -
131 131  {{code}}
132 132  __italic text__
133 133  {{/code}}
132 +**. **Underline**: Enclose text with double tildes.
134 134  
135 135  
136 -*
137 -** (((
138 -=== **Underline**: Enclose text with double tildes. ===
139 -)))
140 -
141 141  {{code}}
142 142  ~~underlined text~~
143 143  {{/code}}
138 +*. **Lists**: Create ordered and unordered lists for structured information.
144 144  
140 +**. **Unordered List**: Begin lines with asterisk (*) or hyphen (-).
145 145  
146 -*
147 -** (((
148 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 -)))
150 150  
151 151  {{code}}
152 152  * Item 1
153 153  * Item 2
154 154  {{/code}}
147 +**. **Ordered List**: Start lines with a number followed by a period.
155 155  
156 156  
157 -*
158 -** (((
159 -=== **Ordered List**: Start lines with a number followed by a period. ===
160 -)))
161 -
162 162  {{code}}
163 163  1. First item
164 164  2. Second item
165 165  {{/code}}
154 +*. **Links**: Insert internal and external links to connect related content.
166 166  
156 +**. **Internal Link**: Use square brackets with the page name.
167 167  
168 -== **Links** ==
169 169  
170 -
171 -
172 -==== **Internal Link**: Use square brackets with the page name. ====
173 -
174 174  {{code}}
175 175  [[PageName]]
176 176  {{/code}}
162 +**. **External Link**: Provide the URL directly.
177 177  
178 178  
179 -
180 -==== **External Link**: Provide the URL directly. ====
181 -
182 182  {{code}}
183 183  [https://www.example.com]
184 184  {{/code}}
168 +*. **Images**: Embed images to enrich content.
185 185  
186 -(((
187 -=== **Images** ===
188 -)))
189 189  
190 190  {{code}}
191 191   [[image:example.jpg]]
192 192  {{/code}}
193 193  
175 +
194 194  
195 -== **Utilizing XWiki Macros** ==
177 +**3. Utilizing XWiki Macros**
196 196  
197 197  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
198 198  
199 -== Embed Macro ==
181 +1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
200 200  
201 -The Embed macro shows external content like YouTube videos.
202 202  
203 -{{example}}
204 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
205 -{{/example}}
184 +{{code}}
185 +{{box}}
186 +Your content here.
187 +{{/box}}
188 +{{/code}}
206 206  
190 +
191 +1. **Info Macro**: Displays an informational message, often used for tips or notes.
207 207  
208 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
209 209  
210 210  {{code}}
211 211  {{info}}
... ... @@ -213,19 +213,20 @@
213 213  {{/info}}
214 214  {{/code}}
215 215  
200 +
201 +1. **Warning Macro**: Highlights warnings or important notices.
216 216  
217 -== Footnote Macro ==
218 218  
219 -The Footnote macro adds footnotes to the page.
204 +{{code}}
205 +{{warning}}
206 +Caution: Proceed with care.
207 +{{/warning}}
208 +{{/code}}
220 220  
221 -{{example}}
222 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
223 -{{putFootnotes/}}
224 -{{/example}}
210 +
211 +1. **Code Macro**: Renders code snippets with syntax highlighting.
225 225  
226 226  
227 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
228 -
229 229  {{code}}
230 230  {{code language="python"}}
231 231  def hello_world():
... ... @@ -233,8 +233,9 @@
233 233  {{/code}}
234 234  {{/code}}
235 235  
221 +
222 +1. **Gallery Macro**: Creates an image gallery from attached images.
236 236  
237 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
238 238  
239 239  {{code}}
240 240  {{gallery}}
... ... @@ -243,69 +243,40 @@
243 243  {{/gallery}}
244 244  {{/code}}
245 245  
232 +
233 +1. **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings.
246 246  
247 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
248 248  
249 249  {{code}}
250 250  {{toc/}}
251 251  {{/code}}
252 252  
253 -== Video Macro ==
240 +
241 +1. **Include Macro**: Embeds content from another page.
254 254  
255 -The Video macro embeds videos.
256 256  
257 -{{example}}
258 -{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
259 -{{/example}}
244 +{{code}}
245 +{{include reference="PageName"/}}
246 +{{/code}}
260 260  
261 -== Expandable Macro ==
262 -The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`.
248 +
249 +1. **Display Macro**: Displays the content of another document or an object property.
263 263  
264 -{{example}}
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*
273 273  
274 -{{expandable summary="📊 Key Statistics"}}
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
279 -{{/expandable}}
252 +{{code}}
253 +{{display reference="PageName"/}}
254 +{{/code}}
280 280  
281 -{{expandable summary="🔬 Findings"}}
282 -- Support for **g-factor theory**
283 -- Agreement on **heritability of intelligence**
284 -- Political lean: left = environmental, right = genetic causes
285 -{{/expandable}}
256 +
257 +1. **Velocity Macro**: Executes Velocity scripts for dynamic content generation.
286 286  
287 -{{expandable summary="📝 Critique"}}
288 -- Largest expert survey on intelligence
289 -- **Western-only sample**, possible **self-selection bias**
290 -{{/expandable}}
291 291  
292 -{{expandable summary="📌 Relevance"}}
293 -- Shows **ideological divide** in science
294 -- Highlights **media vs expert disconnect**
295 -{{/expandable}}
260 +{{code}}
261 +{{velocity}}
262 +#set($greeting = "Hello, $user.name!")
263 +$greeting
264 +{{/velocity}}
265 +{{/code}}
296 296  
297 -{{expandable summary="🔍 Explore More"}}
298 -- Global surveys on intelligence beliefs
299 -- Media analysis follow-up studies
300 -{{/expandable}}
301 -
302 -{{expandable summary="📄 Download"}}
303 -[[Download Study>>attach:10.1016_j.intell.2019.101406.pdf]]
304 -{{/expandable}}
305 -{{/expandable}}
306 -{{/example}}
307 -
308 -
309 -== See Also: ==
310 -
311 -[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]
267 +
268 +1. **HTML Macro**: Allows the inclusion of