0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/05/14 17:18

From version 33.1
edited by Ryan C
on 2025/05/14 15:59
Change comment: There is no comment for this version
To version 34.1
edited by Ryan C
on 2025/05/14 16:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -16,6 +16,77 @@
16 16  
17 17  
18 18  
19 +== 🔍 **Useful Tips & Best Practices** ==
20 +
21 +* **Save drafts frequently:** Press Ctrl+S regularly.
22 +* **Macros** greatly simplify content formatting—use / often.
23 +* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
24 +* **Use minimal formatting** to ensure readability.
25 +
26 +----
27 +
28 += ⚡**Guests can contribute** =
29 +
30 +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.
31 +1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
32 +1. Leave comments, give suggestions, request features.
33 +
34 +== **Content Guidelines** ==
35 +
36 +* 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.
37 +* 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.
38 +
39 +== **Directories and Page URLs** ==
40 +
41 +* 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.
42 +
43 +
44 +
45 +== **XWiki Editing Modes** ==
46 +
47 +XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
48 +
49 +* **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
50 +* **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.
51 +
52 +== **Essential Formatting Options** ==
53 +
54 +To ensure content is both engaging and accessible, utilize the following formatting techniques:
55 +
56 +* **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.
57 +
58 +{{code}}
59 + + Heading Level 1
60 + ++ Heading Level 2
61 + +++ Heading Level 3
62 +{{/code}}
63 +
64 +
65 +== **Links** ==
66 +
67 +
68 +
69 +==== **Internal Link**: Use square brackets with the page name. ====
70 +
71 +{{code}}
72 +[[PageName]]
73 +{{/code}}
74 +
75 +
76 +
77 +==== **External Link**: Provide the URL directly. ====
78 +
79 +{{code}}
80 +[https://www.example.com]
81 +{{/code}}
82 +
83 +(((
84 +=== ===
85 +)))
86 +
87 +
88 +== ==
89 +
19 19  == ⚡ **Using the / Macro Shortcut** ==
20 20  
21 21  The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
... ... @@ -38,8 +38,16 @@
38 38  In this section we will go over many of the common macros used. The source code is how you use the macro editing in Wiki mode. If you are doing standard WYSIWYG edit mode (the default mode you get when you click edit instead of the dropdown), you can call most of these macros by simply typing /thecommand
39 39  
40 40  
41 -== Gallery Macro `/gallery` ==
112 +=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
42 42  
114 +
115 +{{code}}
116 +{{toc/}}
117 +{{/code}}
118 +
119 +
120 +== **Gallery Macro** `/gallery` ==
121 +
43 43  {{example}}
44 44  {{gallery}}
45 45  [[1747262485678-297.png]]
... ... @@ -48,7 +48,7 @@
48 48  {{/example}}
49 49  
50 50  
51 -== Alternatively `/carousel` ==
130 +== **Alternatively** `/carousel` ==
52 52  
53 53  {{example}}
54 54  {{carousel/}}
... ... @@ -56,7 +56,7 @@
56 56  
57 57  {{/example}}
58 58  
59 -== Boilerplate Box ==
138 +== **Boilerplate Box** ==
60 60  
61 61  {{example}}
62 62  {{box cssClass="highlight"}}
... ... @@ -64,18 +64,10 @@
64 64  {{/box}}
65 65  {{/example}}
66 66  
67 -== Velocity Greeting ==
146 +== ==
68 68  
69 -{{example}}
70 -{{velocity}}
71 -#set($name = "Visitor")
72 -Hello, $name!
73 -{{/velocity}}
74 -{{/example}}
148 +== **Info vs Warning **`/info box` ==
75 75  
76 -
77 -== Info vs Warning `/info box` ==
78 -
79 79  {{example}}
80 80  {{info}}
81 81  This is an info box.
... ... @@ -86,7 +86,7 @@
86 86  {{/warning}}
87 87  {{/example}}
88 88  
89 -== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
160 +== **Footnote Demo** `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
90 90  
91 91  {{example}}
92 92  footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
... ... @@ -95,18 +95,10 @@
95 95  {{/example}}
96 96  
97 97  
98 -== Groovy Lookup ==
169 +== ==
99 99  
100 -{{example}}
101 -{{groovy}}
102 -def now = new Date()
103 -println("Current time: " + now)
104 -{{/groovy}}
105 -{{/example}}
171 +== **Expandable Summary** `/expandable`  VERY USEFUL MACRO ==
106 106  
107 -
108 -== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
109 -
110 110  {{example}}
111 111  {{expandable summary="🧠 Study Summary"}}
112 112  Key findings go here.
... ... @@ -113,29 +113,8 @@
113 113  {{/expandable}}
114 114  {{/example}}
115 115  
116 -== List Formatting ==
179 +== ==
117 117  
118 -{{example}}
119 -*Bad formatting*
120 -
121 -* use - inconsistently
122 -** Good formatting:
123 -* Consistent bullet style
124 -* Indented items properly
125 -{{/example}}
126 -
127 -== Python Code ==
128 -
129 -{{example}}
130 -{{code language="python"}}
131 -def greet():
132 - print("Hello World")
133 -{{/code}}
134 -{{/example}}
135 -
136 -== ==
137 -
138 -
139 139  == 📎 **Attachments and Images** ==
140 140  
141 141  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -147,7 +147,7 @@
147 147  * Drag-and-drop or select your file to upload it instantly.
148 148  * Uploaded files will automatically be listed as attachments at the bottom of your page.
149 149  
150 -== Audio Embedding for attached media its better to use the code sometimes but you can embed media with `/embed content` for external media and `/embed JWPlayer` ==
192 +== **Audio Embedding** for attached media its better to use the code sometimes but you can embed media with `/embed content` for external media and `/embed JWPlayer` ==
151 151  
152 152  {{example}}
153 153  {{html}}
... ... @@ -171,7 +171,7 @@
171 171  
172 172  
173 173  
174 -=== **You can also use this format to insert images** ===
216 +=== **Alternatively: `~[~[image~:image.png]]`** ===
175 175  
176 176  {{example}}
177 177  [[image:1747262485678-297.png]]
... ... @@ -179,92 +179,10 @@
179 179  
180 180  
181 181  
224 +== ==
182 182  
183 -{{code}}
184 - [[image:example.jpg]]
185 -{{/code}}
186 -
187 -
188 -
189 -
190 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
191 -
192 -* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
193 -* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
194 -* **Creating Links**:
195 -** Highlight text and click **"Link"** or use shortcut Ctrl+K.
196 -** Paste or select the page URL to link internally.
197 -
198 198  ----
199 199  
200 -== 🔍 **Useful Tips & Best Practices** ==
201 -
202 -* **Save drafts frequently:** Press Ctrl+S regularly.
203 -* **Macros** greatly simplify content formatting—use / often.
204 -* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
205 -* **Use minimal formatting** to ensure readability.
206 -
207 -----
208 -
209 -= ⚡**Guests can contribute** =
210 -
211 -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.
212 -1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
213 -1. Leave comments, give suggestions, request features.
214 -
215 -== **Content Guidelines** ==
216 -
217 -* 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.
218 -* 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.
219 -
220 -== **Directories and Page URLs** ==
221 -
222 -* 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.
223 -
224 -
225 -
226 -== **XWiki Editing Modes** ==
227 -
228 -XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
229 -
230 -* **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
231 -* **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.
232 -
233 -== **Essential Formatting Options** ==
234 -
235 -To ensure content is both engaging and accessible, utilize the following formatting techniques:
236 -
237 -* **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.
238 -
239 -{{code}}
240 - + Heading Level 1
241 - ++ Heading Level 2
242 - +++ Heading Level 3
243 -{{/code}}
244 -
245 -
246 -== **Links** ==
247 -
248 -
249 -
250 -==== **Internal Link**: Use square brackets with the page name. ====
251 -
252 -{{code}}
253 -[[PageName]]
254 -{{/code}}
255 -
256 -
257 -
258 -==== **External Link**: Provide the URL directly. ====
259 -
260 -{{code}}
261 -[https://www.example.com]
262 -{{/code}}
263 -
264 -(((
265 -=== ===
266 -)))
267 -
268 268  == **Utilizing XWiki Macros** ==
269 269  
270 270  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
... ... @@ -287,18 +287,8 @@
287 287  {{/code}}
288 288  
289 289  
290 -== Footnote Macro ==
250 +== **Code Macro**: Renders code snippets with syntax highlighting. ==
291 291  
292 -The Footnote macro adds footnotes to the page.
293 -
294 -{{example}}
295 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
296 -{{putFootnotes/}}
297 -{{/example}}
298 -
299 -
300 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
301 -
302 302  {{code}}
303 303  {{code language="python"}}
304 304  def hello_world():
... ... @@ -307,26 +307,8 @@
307 307  {{/code}}
308 308  
309 309  
310 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
260 +== **Video Macro**: `/video` The Video macro embeds videos. ==
311 311  
312 -{{code}}
313 -{{gallery}}
314 -[[image1.jpg]]
315 -[[image2.jpg]]
316 -{{/gallery}}
317 -{{/code}}
318 -
319 -
320 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
321 -
322 -{{code}}
323 -{{toc/}}
324 -{{/code}}
325 -
326 -== Video Macro ==
327 -
328 -The Video macro embeds videos.
329 -
330 330  {{example}}
331 331  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
332 332  {{/example}}