0 Votes

Changes for page Start here if you're new

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

From version 40.1
edited by Ryan C
on 2025/05/14 16:47
Change comment: There is no comment for this version
To version 12.1
edited by Ryan C
on 2025/03/16 01:25
Change comment: There is no comment for this version

Summary

Details

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