0 Votes

Changes for page Start here if you're new

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

From version 9.1
edited by Ryan C
on 2025/03/16 01:20
Change comment: There is no comment for this version
To version 37.1
edited by Ryan C
on 2025/05/14 16:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,68 +2,23 @@
1 -= =
2 2  
3 3  ----
4 4  
5 -== Getting Started with XWiki ==
4 +== πŸ“– Table of Contents ==
6 6  
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 -
11 11  {{toc/}}
12 12  
13 13  ----
14 14  
15 -== πŸ“Ž **Attachments and Images** ==
16 16  
17 -You can easily upload files and images directly from the WYSIWYG editor:
11 +== Getting Started with XWiki ==
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.
18 18  
19 -**Uploading Attachments:**
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.
20 20  
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.
25 -
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 -
61 61  == πŸ” **Useful Tips & Best Practices** ==
62 62  
63 -* **Save drafts frequently:** Press Ctrl+S regularly.
64 64  * **Macros** greatly simplify content formattingβ€”use / often.
65 -* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
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.
66 66  * **Use minimal formatting** to ensure readability.
67 67  
68 68  ----
... ... @@ -78,29 +78,19 @@
78 78  * 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.
79 79  * 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.
80 80  
81 -== **Directories and Page URLs** ==
82 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 -
87 87  == **XWiki Editing Modes** ==
88 88  
89 89  XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:ξˆ†
90 90  
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.ξˆ†
41 +* **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.
42 +* **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.
94 94  
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 -
99 99  == **Essential Formatting Options** ==
100 100  
101 -To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
46 +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.ξˆ†
48 +* **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
104 104  
105 105  {{code}}
106 106   + Heading Level 1
... ... @@ -109,162 +109,231 @@
109 109  {{/code}}
110 110  
111 111  
112 -=== **Text Formatting** ===
57 +== **Links** ==
113 113  
114 114  
115 115  
116 -** (((
117 -=== **Bold**: Surround text with double asterisks. ===
118 -)))
61 +==== **Internal Link**: Use square brackets with the page name. ====
62 +{{example}}
63 +[[PageName]]
64 +{{/example}}
119 119  
120 -{{code}}
121 -**bold text**
122 -{{/code}}
123 123  
67 +==== **External Link**: Provide the URL directly. ====
68 +{{example}}
69 +[https://www.example.com]
70 +{{/example}}
124 124  
125 -** (((
126 -=== **Italics**: Use double underscores. ===
127 -)))
128 128  
129 -{{code}}
130 -__italic text__
131 -{{/code}}
73 +== ⚑ **Using the / Macro Shortcut** ==
132 132  
75 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
133 133  
134 -** (((
135 -=== **Underline**: Enclose text with double tildes. ===
136 -)))
77 +* Simply type / and start typing the macro name or feature you want to add.
78 +* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
79 +* Example macros include:
80 +** /toc – Table of Contents
81 +** /box – Insert Box Macro
82 +** /gallery – Image Gallery
83 +** /footnote – Add footnotes to your text
84 +** /code – Code blocks for programming snippets
137 137  
138 -{{code}}
139 -~~underlined text~~
140 -{{/code}}
86 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
141 141  
88 +----
89 += πŸ“š Macro Examples & Formatting Guide =
142 142  
143 -** (((
144 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
145 -)))
91 +== πŸ§ͺ Macro Showcase: Source + Output + Slash Command ==
146 146  
147 -{{code}}
148 -* Item 1
149 -* Item 2
150 -{{/code}}
93 +All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
151 151  
95 +----
152 152  
153 -** (((
154 -=== **Ordered List**: Start lines with a number followed by a period. ===
155 -)))
97 +== Table of Contents Macro (`/toc`) ==
156 156  
157 -{{code}}
158 -1. First item
159 -2. Second item
160 -{{/code}}
99 +{{expandable summary="πŸ“˜ Table of Contents Macro (`/toc`)"}}
100 +{{example}}
101 +{{toc/}}
102 +{{/example}}
103 +{{/expandable}}
161 161  
105 +----
162 162  
163 -== **Links** ==
107 +== Gallery Macro (`/gallery`) ==
164 164  
165 -==== **Internal Link**: Use square brackets with the page name. ====
109 +{{expandable summary="πŸ–ΌοΈ Gallery Macro (`/gallery`)"}}
110 +{{example}}
111 +{{gallery}}
112 +[[1747262485678-297.png]]
113 +[[image:photo2.jpg]]
114 +{{/gallery}}
115 +{{/example}}
116 +{{/expandable}}
166 166  
167 -{{code}}
168 -[[PageName]]
169 -{{/code}}
118 +----
170 170  
171 -*
172 -** (((
173 -==== **External Link**: Provide the URL directly. ====
174 -)))
120 +== Carousel Macro (`/carousel`) ==
175 175  
176 -{{code}}
177 -[https://www.example.com]
178 -{{/code}}
122 +{{expandable summary="πŸ“½οΈ Carousel Macro (`/carousel`)"}}
123 +{{example}}
124 +{{carousel/}}
125 +{{/example}}
126 +{{/expandable}}
179 179  
180 -* (((
181 -=== **Images** ===
182 -)))
128 +----
183 183  
184 -{{code}}
185 - [[image:example.jpg]]
186 -{{/code}}
130 +== Box Macro (`/box`) ==
187 187  
132 +{{expandable summary="πŸ“¦ Box Macro (`/box`)"}}
133 +{{example}}
134 +{{box cssClass="highlight"}}
135 +Insert your highlighted content here.
136 +{{/box}}
137 +{{/example}}
138 +{{/expandable}}
188 188  
189 -== **Utilizing XWiki Macros** ==
140 +----
190 190  
191 -Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
142 +== Info and Warning Boxes (`/info`, `/warning`) ==
192 192  
193 -**Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
144 +{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
145 +{{example}}
146 +{{info}}This is an info box.{{/info}}
194 194  
195 -{{code}}
196 -{{box}}
197 -Your content here.
198 -{{/box}}
199 -{{/code}}
148 +{{warning}}This is a warning box.{{/warning}}
149 +{{/example}}
150 +{{/expandable}}
200 200  
152 +----
201 201  
202 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
154 +== Footnotes (`/footnote`, `/put footnotes`) ==
203 203  
204 -{{code}}
205 -{{info}}
206 -This is an informational note.
207 -{{/info}}
208 -{{/code}}
156 +{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
157 +{{example}}
158 +This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
209 209  
160 +{{putFootnotes/}}
161 +{{/example}}
162 +{{/expandable}}
210 210  
211 -=== **Warning Macro**: Highlights warnings or important notices. ===
164 +----
212 212  
213 -{{code}}
214 -{{warning}}
215 -Caution: Proceed with care.
216 -{{/warning}}
217 -{{/code}}
166 +== Expandable Macro (`/expandable`) ==
218 218  
168 +{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
169 +{{example}}
170 +{{expandable summary="Click to expand"}}
171 +This content is hidden until clicked.
172 +{{/expandable}}
173 +{{/example}}
174 +{{/expandable}}
219 219  
220 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
176 +----
221 221  
222 -{{code}}
178 +== Embed Macro (`/embed content`) ==
179 +
180 +{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
181 +{{example}}
182 +{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
183 +{{/example}}
184 +{{/expandable}}
185 +
186 +----
187 +
188 +== Code Macro (`/code`) ==
189 +
190 +{{expandable summary="πŸ’» Code Block Macro (`/code`)"}}
191 +{{example}}
223 223  {{code language="python"}}
224 224  def hello_world():
225 225   print("Hello, world!")
226 226  {{/code}}
227 -{{/code}}
196 +{{/example}}
197 +{{/expandable}}
228 228  
199 +----
229 229  
230 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
201 +== Image Insert (`[[image:...]]`) ==
231 231  
232 -{{code}}
233 -{{gallery}}
234 -[[image1.jpg]]
235 -[[image2.jpg]]
236 -{{/gallery}}
237 -{{/code}}
203 +{{expandable summary="πŸ–ΌοΈ Image Macro (`[[image:filename.jpg]]`)"}}
204 +{{example}}
205 +[[image:1747262485678-297.png]]
206 +{{/example}}
207 +{{/expandable}}
238 238  
209 +----
239 239  
240 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
211 +== Audio Embed (HTML tag or `/embed JWPlayer`) ==
241 241  
242 -{{code}}
243 -{{toc/}}
244 -{{/code}}
213 +{{expandable summary="πŸ”Š Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
214 +{{example}}
215 +{{html}}
216 +<audio controls>
217 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
218 + Your browser does not support the audio element.
219 +</audio>
220 +{{/html}}
221 +{{/example}}
222 +{{/expandable}}
245 245  
224 +----
246 246  
247 -=== **Include Macro**: Embeds content from another page. ===
226 +== Video Embed Macro (`/video`) ==
248 248  
249 -{{code}}
250 -{{include reference="PageName"/}}
251 -{{/code}}
228 +{{expandable summary="🎬 Video Macro (`/video`)"}}
229 +{{example}}
230 +{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
231 +{{/example}}
232 +{{/expandable}}
252 252  
234 +----
253 253  
254 -=== **Display Macro**: Displays the content of another document or an object property. ===
236 +== Full Example: Expandable Study Summary (`/expandable`) ==
255 255  
256 -{{code}}
257 -{{display reference="PageName"/}}
258 -{{/code}}
238 +{{expandable summary="πŸ“š Full Use Case – Study Summary Macro (`/expandable`)"}}
239 +{{example}}
240 +{{expandable summary="Study: The Wilson Effect"}}
241 +**Source:** *Twin Research and Human Genetics (2013)*
242 +**Author:** *Thomas J. Bouchard Jr.*
243 +**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
259 259  
245 +{{expandable summary="πŸ“Š Key Statistics"}}
246 +- IQ heritability rises to **0.80** by adulthood
247 +- Shared environment drops to **0.10**
248 +{{/expandable}}
260 260  
261 -=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
250 +{{expandable summary="πŸ”¬ Findings"}}
251 +- Genetic influence strengthens over time
252 +- Monozygotic twins’ IQ similarity increases with age
253 +{{/expandable}}
262 262  
263 -{{code}}
264 -{{velocity}}
265 -#set($greeting = "Hello, $user.name!")
266 -$greeting
267 -{{/velocity}}
268 -{{/code}}
255 +{{expandable summary="πŸ“ Critique & Observations"}}
256 +- Strength: Large dataset, longitudinal
257 +- Limitation: Mostly Western countries
258 +{{/expandable}}
269 269  
270 -
260 +{{expandable summary="πŸ“Œ Relevance"}}
261 +- Strong support for genetic IQ theories
262 +- Diminishing environmental influence
263 +{{/expandable}}
264 +
265 +{{expandable summary="πŸ“„ Download"}}
266 +[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
267 +{{/expandable}}
268 +
269 +{{/expandable}}
270 +{{/example}}
271 +{{/expandable}}
272 +
273 +----
274 +
275 +== Bonus: Boilerplate Example Template ==
276 +
277 +{{expandable summary="πŸ“‹ Example Macro Template (`/example`)"}}
278 +{{example}}
279 +{{example}}
280 +Your macro goes here.
281 +{{/example}}
282 +{{/example}}
283 +{{/expandable}}
284 +
1747262485678-297.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.AdminAngriff
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 MB
Content