0 Votes

Changes for page Start here if you're new

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

From version 41.1
edited by Ryan C
on 2025/05/14 16:51
Change comment: There is no comment for this version
To version 10.1
edited by Ryan C
on 2025/03/16 01:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,23 +1,68 @@
1 += =
2 +
1 1  ----
2 2  
3 -== πŸ“– Table of Contents ==
5 +== Getting Started with XWiki ==
4 4  
7 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
8 +
9 +== πŸ“– Table of Contents: ==
10 +
5 5  {{toc/}}
6 6  
7 7  ----
8 8  
15 +== πŸ“Ž **Attachments and Images** ==
9 9  
10 -== **Getting Started with XWiki** ==
17 +You can easily upload files and images directly from the WYSIWYG editor:
11 11  
12 -If you would like to add content to the wiki, you can do so as a guest, but some of your options will be limited. its recommended to create an account and post that way. If you want to contribute but dont know where to start or you're overwhelmed by the options, the global dashboard will always be updated with whats being worked on currently. to see all the categories and pages we currently have, go here. IMAGE
13 -Adding content should be relegated to these main categories, or new ones that you want to create. You shouldn't need to edit any pages outside of it for the most part, they may be linked elsewhere as resources for you, but they wont be editable. If you just have some pictures you would like to add to a topic, attach them at the bottom of the page and they will be automatically included in the gallery on the page if it has one. Changes or content added can always be revised to an earlier version easily, so don't be concerned with unwanted additions or edits. You can use the sandbox to experiment with formatting.
19 +**Uploading Attachments:**
14 14  
15 -On top of the category content, there are also applications that allow you to take part in the wiki via many other avenues. There is a forum, AI is in the works, Ideas, Suggestions for improvements, A Visualizer, Music Library, Research Papers collection, and many other things, as well as new extensions being added often. The message of the day will alert you to some of the things ive been working on or have finished recently. If you would like to have your Pro White group listed here let me know and I'll add it so others can join with you and network. This has thus far been mostly a solo undertaking, so I apologize if things break for extended times, I assure you I'm working on them when I can, but I have other things to attend to as well. There is typically daily changes and updates being made.
21 +* Click **Edit** to enter the WYSIWYG editor.
22 +* Click on the **Attachment** icon (πŸ“Ž paperclip icon).
23 +* Drag-and-drop or select your file to upload it instantly.
24 +* Uploaded files will automatically be listed as attachments at the bottom of your page.
16 16  
26 +=== **Inserting Images with Enlargable Thumbnails** ===
27 +
28 +1. In the editor, click the **"Insert Image"** icon from the toolbar.
29 +1. Upload or select the image.
30 +1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
31 +
32 +----
33 +
34 +== ⚑ **Using the / Macro Shortcut** ==
35 +
36 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
37 +
38 +* Simply type / and start typing the macro name or feature you want to add.
39 +* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
40 +* Example macros include:
41 +** /toc – Table of Contents
42 +** /box – Insert Box Macro
43 +** /gallery – Image Gallery
44 +** /footnote – Add footnotes to your text
45 +** /code – Code blocks for programming snippets
46 +
47 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
48 +
49 +----
50 +
51 +== ✏️** Basic Formatting and Links (Quick Guide)** ==
52 +
53 +* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
54 +* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
55 +* **Creating Links**:
56 +** Highlight text and click **"Link"** or use shortcut Ctrl+K.
57 +** Paste or select the page URL to link internally.
58 +
59 +----
60 +
17 17  == πŸ” **Useful Tips & Best Practices** ==
18 18  
63 +* **Save drafts frequently:** Press Ctrl+S regularly.
19 19  * **Macros** greatly simplify content formattingβ€”use / often.
20 -When to insert an image rather than upload the [[image:]] Upload the image at the bottom of the page via the built in extension if you just want to post the image without context. This is always acceptable on any page given that it is relevant. Embed an image when you are adding context to it or using it to reinforce some context already present. Same with videos.
65 +* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
21 21  * **Use minimal formatting** to ensure readability.
22 22  
23 23  ----
... ... @@ -33,18 +33,29 @@
33 33  * 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.
34 34  * 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.
35 35  
81 +== **Directories and Page URLs** ==
82 +
83 +* 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.
84 +
85 +
86 +
36 36  == **XWiki Editing Modes** ==
37 37  
38 38  XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:ξˆ†
39 39  
40 -* **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.
41 -* **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.
91 +* **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ξˆξˆ†
92 +* **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.ξˆ†
93 +* **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.ξˆ†
42 42  
95 +=== **Switching Between Syntaxes** ===
96 +
97 +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ξˆξˆ†
98 +
43 43  == **Essential Formatting Options** ==
44 44  
45 -To ensure content is both engaging and accessible, utilize the following formatting techniques:
101 +To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
46 46  
47 -* **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.4
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.ξˆ†
48 48  
49 49  {{code}}
50 50   + Heading Level 1
... ... @@ -53,239 +53,169 @@
53 53  {{/code}}
54 54  
55 55  
56 -== **Links** ==
112 +=== **Text Formatting** ===
57 57  
58 58  
59 59  
60 -==== **Internal Link**: Use square brackets with the page name. ====
116 +*
117 +** (((
118 +=== **Bold**: Surround text with double asterisks. ===
119 +)))
61 61  
62 -{{example}}
63 -[[Resources>>doc:Guides and Help.Resources.WebHome]]
64 -{{/example}}
121 +{{code}}
122 +**bold text**
123 +{{/code}}
65 65  
66 66  
67 -==== **External Link**: Provide the URL directly. ====
126 +*
127 +** (((
128 +=== **Italics**: Use double underscores. ===
129 +)))
68 68  
69 -{{example}}
70 -[[Full Feature List>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/]]
71 -{{/example}}
131 +{{code}}
132 +__italic text__
133 +{{/code}}
72 72  
73 73  
74 -== ⚑ **Using the / Macro Shortcut** ==
136 +*
137 +** (((
138 +=== **Underline**: Enclose text with double tildes. ===
139 +)))
75 75  
76 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
141 +{{code}}
142 +~~underlined text~~
143 +{{/code}}
77 77  
78 -* Simply type / and start typing the macro name or feature you want to add.
79 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
80 -* Example macros include:
81 -** /toc – Table of Contents
82 -** /box – Insert Box Macro
83 -** /gallery – Image Gallery
84 -** /footnote – Add footnotes to your text
85 -** /code – Code blocks for programming snippets
86 86  
87 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
146 +*
147 +** (((
148 +=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 +)))
88 88  
151 +{{code}}
152 +* Item 1
153 +* Item 2
154 +{{/code}}
89 89  
90 -[[Full Macro List>>https://www.thewhitearchive.org/bin/view/XWiki/XWikiSyntaxMacrosList]]
91 91  
92 -----
157 +*
158 +** (((
159 +=== **Ordered List**: Start lines with a number followed by a period. ===
160 +)))
93 93  
94 -= πŸ“š Macro Examples & Formatting Guide =
162 +{{code}}
163 +1. First item
164 +2. Second item
165 +{{/code}}
95 95  
96 -== πŸ§ͺ Macro Showcase: Source + Output + Slash Command ==
97 97  
98 -All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
168 +== **Links** ==
99 99  
100 -----
101 101  
102 -== Table of Contents Macro (`/toc`) ==
103 103  
104 -{{expandable summary="πŸ“˜ Table of Contents Macro (`/toc`)"}}
105 -{{example}}
106 -{{toc/}}
107 -{{/example}}
108 -{{/expandable}}
172 +==== ** Internal Link**: Use square brackets with the page name. ====
109 109  
110 -----
174 +{{code}}
175 +[[PageName]]
176 +{{/code}}
111 111  
112 -== Gallery Macro (`/gallery`) ==
178 +*
179 +** (((
180 +==== **External Link**: Provide the URL directly. ====
181 +)))
113 113  
114 -{{expandable summary="πŸ–ΌοΈ Gallery Macro (`/gallery`)"}}
115 -{{example}}
116 -{{gallery}}
117 -[[1747262485678-297.png]]
118 -[[image:photo2.jpg]]
119 -{{/gallery}}
120 -{{/example}}
121 -{{/expandable}}
183 +{{code}}
184 +[https://www.example.com]
185 +{{/code}}
122 122  
123 -----
187 +* (((
188 +=== **Images** ===
189 +)))
124 124  
125 -== Carousel Macro (`/carousel`) ==
191 +{{code}}
192 + [[image:example.jpg]]
193 +{{/code}}
126 126  
127 -{{expandable summary="πŸ“½οΈ Carousel Macro (`/carousel`)"}}
128 -{{example}}
129 -{{carousel/}}
130 -{{/example}}
131 -{{/expandable}}
132 132  
133 -----
196 +== **Utilizing XWiki Macros** ==
134 134  
135 -== Box Macro (`/box`) ==
198 +Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
136 136  
137 -{{expandable summary="πŸ“¦ Box Macro (`/box`)"}}
138 -{{example}}
139 -{{box cssClass="highlight"}}
140 -Insert your highlighted content here.
200 +**Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
201 +
202 +{{code}}
203 +{{box}}
204 +Your content here.
141 141  {{/box}}
142 -{{/example}}
143 -{{/expandable}}
206 +{{/code}}
144 144  
145 -----
146 146  
147 -== Info and Warning Boxes (`/info`, `/warning`) ==
209 +=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
148 148  
149 -{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
150 -{{example}}
211 +{{code}}
151 151  {{info}}
152 -This is an info box.
213 +This is an informational note.
153 153  {{/info}}
215 +{{/code}}
154 154  
217 +
218 +=== **Warning Macro**: Highlights warnings or important notices. ===
219 +
220 +{{code}}
155 155  {{warning}}
156 -This is a warning box.
222 +Caution: Proceed with care.
157 157  {{/warning}}
158 -{{/example}}
159 -{{/expandable}}
224 +{{/code}}
160 160  
161 -----
162 162  
163 -== Footnotes (`/footnote`, `/put footnotes`) ==
227 +=== **Code Macro**: Renders code snippets with syntax highlighting. ===
164 164  
165 -{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
166 -{{example}}
167 -This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
168 -
169 -{{putFootnotes/}}
170 -{{/example}}
171 -{{/expandable}}
172 -
173 -----
174 -
175 -== Expandable Macro (`/expandable`) ==
176 -
177 -{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
178 -{{example}}
179 -{{expandable summary="Click to expand"}}
180 -This content is hidden until clicked.
181 -{{/expandable}}
182 -{{/example}}
183 -{{/expandable}}
184 -
185 -----
186 -
187 -== Embed Macro (`/embed content`) ==
188 -
189 -{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
190 -{{example}}
191 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
192 -{{/example}}
193 -{{/expandable}}
194 -
195 -----
196 -
197 -== Code Macro (`/code`) ==
198 -
199 -{{expandable summary="πŸ’» Code Block Macro (`/code`)"}}
200 -{{example}}
229 +{{code}}
201 201  {{code language="python"}}
202 202  def hello_world():
203 203   print("Hello, world!")
204 204  {{/code}}
205 -{{/example}}
206 -{{/expandable}}
234 +{{/code}}
207 207  
208 -----
209 209  
210 -== Image Insert (`[[image:...]]`) ==
237 +=== **Gallery Macro**: Creates an image gallery from attached images. ===
211 211  
212 -{{expandable summary="πŸ–ΌοΈ Image Macro (`[[image:filename.jpg]]`)"}}
213 -{{example}}
214 -[[image:1747262485678-297.png]]
215 -{{/example}}
216 -{{/expandable}}
239 +{{code}}
240 +{{gallery}}
241 +[[image1.jpg]]
242 +[[image2.jpg]]
243 +{{/gallery}}
244 +{{/code}}
217 217  
218 -----
219 219  
220 -== Audio Embed (HTML tag or `/embed JWPlayer`) ==
247 +=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
221 221  
222 -{{expandable summary="πŸ”Š Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
223 -{{example}}
224 -{{html}}
225 -<audio controls>
226 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
227 - Your browser does not support the audio element.
228 -</audio>
229 -{{/html}}
230 -{{/example}}
231 -{{/expandable}}
249 +{{code}}
250 +{{toc/}}
251 +{{/code}}
232 232  
233 -----
234 234  
235 -== Video Embed Macro (`/video`) ==
254 +=== **Include Macro**: Embeds content from another page. ===
236 236  
237 -{{expandable summary="🎬 Video Macro (`/video`)"}}
238 -{{example}}
239 -{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
240 -{{/example}}
241 -{{/expandable}}
256 +{{code}}
257 +{{include reference="PageName"/}}
258 +{{/code}}
242 242  
243 -----
244 244  
245 -== Full Example: Expandable Study Summary (`/expandable`) ==
261 +=== **Display Macro**: Displays the content of another document or an object property. ===
246 246  
247 -{{expandable summary="πŸ“š Full Use Case – Study Summary Macro (`/expandable`)"}}
248 -{{example}}
249 -{{expandable summary="Study: The Wilson Effect"}}
250 -**Source:** *Twin Research and Human Genetics (2013)*
251 -**Author:** *Thomas J. Bouchard Jr.*
252 -**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
263 +{{code}}
264 +{{display reference="PageName"/}}
265 +{{/code}}
253 253  
254 -{{expandable summary="πŸ“Š Key Statistics"}}
255 -- IQ heritability rises to **0.80** by adulthood
256 -- Shared environment drops to **0.10**
257 -{{/expandable}}
258 258  
259 -{{expandable summary="πŸ”¬ Findings"}}
260 -- Genetic influence strengthens over time
261 -- Monozygotic twins’ IQ similarity increases with age
262 -{{/expandable}}
268 +=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
263 263  
264 -{{expandable summary="πŸ“ Critique & Observations"}}
265 -- Strength: Large dataset, longitudinal
266 -- Limitation: Mostly Western countries
267 -{{/expandable}}
270 +{{code}}
271 +{{velocity}}
272 +#set($greeting = "Hello, $user.name!")
273 +$greeting
274 +{{/velocity}}
275 +{{/code}}
268 268  
269 -{{expandable summary="πŸ“Œ Relevance"}}
270 -- Strong support for genetic IQ theories
271 -- Diminishing environmental influence
272 -{{/expandable}}
273 -
274 -{{expandable summary="πŸ“„ Download"}}
275 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
276 -{{/expandable}}
277 -{{/expandable}}
278 -{{/example}}
279 -{{/expandable}}
280 -
281 -----
282 -
283 -== Bonus: Boilerplate Example Template ==
284 -
285 -{{expandable summary="πŸ“‹ Example Macro Template (`/example`)"}}
286 -{{example}}
287 -{{example}}
288 -Your macro goes here.
289 -{{/example}}
290 -{{/example}}
291 -{{/expandable}}
277 +
1747262485678-297.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.AdminAngriff
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 MB
Content
1747266591398-414.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.AdminAngriff
Size
... ... @@ -1,1 +1,0 @@
1 -623.7 KB
Content