... |
... |
@@ -1,204 +1,87 @@ |
1 |
|
-= π Macro Examples & Formatting Guide = |
|
1 |
+= = |
2 |
2 |
|
3 |
3 |
---- |
4 |
4 |
|
5 |
|
-== π Table of Contents == |
|
5 |
+== Getting Started with XWiki == |
6 |
6 |
|
7 |
|
-{{toc/}} |
|
7 |
+This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. |
8 |
8 |
|
9 |
|
----- |
|
9 |
+== π Table of Contents: == |
10 |
10 |
|
11 |
|
-== π§ͺ Macro Showcase: Source + Output + Slash Command == |
|
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]] |
12 |
12 |
|
13 |
|
-All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example |
14 |
|
- |
15 |
15 |
---- |
16 |
16 |
|
17 |
|
-== Table of Contents Macro (`/toc`) == |
|
19 |
+== π Attachments and Images == |
18 |
18 |
|
19 |
|
-{{expandable summary="π Table of Contents Macro (`/toc`)"}} |
20 |
|
-{{example}} |
21 |
|
-{{toc/}} |
22 |
|
-{{/example}} |
23 |
|
-{{/expandable}} |
|
21 |
+You can easily upload files and images directly from the WYSIWYG editor: |
24 |
24 |
|
25 |
|
----- |
|
23 |
+**Uploading Attachments:** |
26 |
26 |
|
27 |
|
-== Gallery Macro (`/gallery`) == |
|
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. |
28 |
28 |
|
29 |
|
-{{expandable summary="πΌοΈ Gallery Macro (`/gallery`)"}} |
30 |
|
-{{example}} |
31 |
|
-{{gallery}} |
32 |
|
-[[1747262485678-297.png]] |
33 |
|
-[[image:photo2.jpg]] |
34 |
|
-{{/gallery}} |
35 |
|
-{{/example}} |
36 |
|
-{{/expandable}} |
|
30 |
+=== Inserting Images with Enlargable Thumbnails === |
37 |
37 |
|
38 |
|
----- |
|
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. |
39 |
39 |
|
40 |
|
-== Carousel Macro (`/carousel`) == |
41 |
|
- |
42 |
|
-{{expandable summary="π½οΈ Carousel Macro (`/carousel`)"}} |
43 |
|
-{{example}} |
44 |
|
-{{carousel/}} |
45 |
|
-{{/example}} |
46 |
|
-{{/expandable}} |
47 |
|
- |
48 |
48 |
---- |
49 |
49 |
|
50 |
|
-== Box Macro (`/box`) == |
|
38 |
+== β‘ Using the / Macro Shortcut == |
51 |
51 |
|
52 |
|
-{{expandable summary="π¦ Box Macro (`/box`)"}} |
53 |
|
-{{example}} |
54 |
|
-{{box cssClass="highlight"}} |
55 |
|
-Insert your highlighted content here. |
56 |
|
-{{/box}} |
57 |
|
-{{/example}} |
58 |
|
-{{/expandable}} |
|
40 |
+The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor: |
59 |
59 |
|
60 |
|
----- |
|
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 |
61 |
61 |
|
62 |
|
-== Info and Warning Boxes (`/info`, `/warning`) == |
|
51 |
+This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax. |
63 |
63 |
|
64 |
|
-{{expandable summary="β οΈ Info and Warning Macros (`/info`, `/warning`)"}} |
65 |
|
-{{example}} |
66 |
|
-{{info}}This is an info box.{{/info}} |
67 |
|
- |
68 |
|
-{{warning}}This is a warning box.{{/warning}} |
69 |
|
-{{/example}} |
70 |
|
-{{/expandable}} |
71 |
|
- |
72 |
72 |
---- |
73 |
73 |
|
74 |
|
-== Footnotes (`/footnote`, `/put footnotes`) == |
|
55 |
+== βοΈ Basic Formatting and Links (Quick Guide) == |
75 |
75 |
|
76 |
|
-{{expandable summary="π§Ύ Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}} |
77 |
|
-{{example}} |
78 |
|
-This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}. |
|
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. |
79 |
79 |
|
80 |
|
-{{putFootnotes/}} |
81 |
|
-{{/example}} |
82 |
|
-{{/expandable}} |
83 |
|
- |
84 |
84 |
---- |
85 |
85 |
|
86 |
|
-== Expandable Macro (`/expandable`) == |
|
65 |
+== π Useful Tips & Best Practices == |
87 |
87 |
|
88 |
|
-{{expandable summary="π§© Expandable Macro (`/expandable`)"}} |
89 |
|
-{{example}} |
90 |
|
-{{expandable summary="Click to expand"}} |
91 |
|
-This content is hidden until clicked. |
92 |
|
-{{/expandable}} |
93 |
|
-{{/example}} |
94 |
|
-{{/expandable}} |
|
67 |
+* **Save drafts frequently:** Press Ctrl+S regularly. |
|
68 |
+* **Macros** greatly simplify content formattingβuse / often. |
|
69 |
+* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them. |
|
70 |
+* **Use minimal formatting** to ensure readability. |
95 |
95 |
|
96 |
96 |
---- |
97 |
97 |
|
98 |
|
-== Embed Macro (`/embed content`) == |
|
74 |
+= β‘Guests can contribute = |
99 |
99 |
|
100 |
|
-{{expandable summary="π Embed Macro (YouTube etc.) (`/embed content`)"}} |
101 |
|
-{{example}} |
102 |
|
-{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} |
103 |
|
-{{/example}} |
104 |
|
-{{/expandable}} |
|
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 |
+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 |
+1. Leave comments, give suggestions, request features. |
105 |
105 |
|
106 |
|
----- |
|
80 |
+== Content Guidelines == |
107 |
107 |
|
108 |
|
-== Code Macro (`/code`) == |
|
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 |
+* 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. |
109 |
109 |
|
110 |
|
-{{expandable summary="π» Code Block Macro (`/code`)"}} |
111 |
|
-{{example}} |
112 |
|
-{{code language="python"}} |
113 |
|
-def hello_world(): |
114 |
|
- print("Hello, world!") |
115 |
|
-{{/code}} |
116 |
|
-{{/example}} |
117 |
|
-{{/expandable}} |
|
85 |
+== Directories and Page URLs == |
118 |
118 |
|
119 |
|
----- |
120 |
|
- |
121 |
|
-== Image Insert (`[[image:...]]`) == |
122 |
|
- |
123 |
|
-{{expandable summary="πΌοΈ Image Macro (`[[image:filename.jpg]]`)"}} |
124 |
|
-{{example}} |
125 |
|
-[[image:1747262485678-297.png]] |
126 |
|
-{{/example}} |
127 |
|
-{{/expandable}} |
128 |
|
- |
129 |
|
----- |
130 |
|
- |
131 |
|
-== Audio Embed (HTML tag or `/embed JWPlayer`) == |
132 |
|
- |
133 |
|
-{{expandable summary="π Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}} |
134 |
|
-{{example}} |
135 |
|
-{{html}} |
136 |
|
-<audio controls> |
137 |
|
- <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg"> |
138 |
|
- Your browser does not support the audio element. |
139 |
|
-</audio> |
140 |
|
-{{/html}} |
141 |
|
-{{/example}} |
142 |
|
-{{/expandable}} |
143 |
|
- |
144 |
|
----- |
145 |
|
- |
146 |
|
-== Video Embed Macro (`/video`) == |
147 |
|
- |
148 |
|
-{{expandable summary="π¬ Video Macro (`/video`)"}} |
149 |
|
-{{example}} |
150 |
|
-{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} |
151 |
|
-{{/example}} |
152 |
|
-{{/expandable}} |
153 |
|
- |
154 |
|
----- |
155 |
|
- |
156 |
|
-== Full Example: Expandable Study Summary (`/expandable`) == |
157 |
|
- |
158 |
|
-{{expandable summary="π Full Use Case β Study Summary Macro (`/expandable`)"}} |
159 |
|
-{{example}} |
160 |
|
-{{expandable summary="Study: The Wilson Effect"}} |
161 |
|
-**Source:** *Twin Research and Human Genetics (2013)* |
162 |
|
-**Author:** *Thomas J. Bouchard Jr.* |
163 |
|
-**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54) |
164 |
|
- |
165 |
|
-{{expandable summary="π Key Statistics"}} |
166 |
|
-- IQ heritability rises to **0.80** by adulthood |
167 |
|
-- Shared environment drops to **0.10** |
168 |
|
-{{/expandable}} |
169 |
|
- |
170 |
|
-{{expandable summary="π¬ Findings"}} |
171 |
|
-- Genetic influence strengthens over time |
172 |
|
-- Monozygotic twinsβ IQ similarity increases with age |
173 |
|
-{{/expandable}} |
174 |
|
- |
175 |
|
-{{expandable summary="π Critique & Observations"}} |
176 |
|
-- Strength: Large dataset, longitudinal |
177 |
|
-- Limitation: Mostly Western countries |
178 |
|
-{{/expandable}} |
179 |
|
- |
180 |
|
-{{expandable summary="π Relevance"}} |
181 |
|
-- Strong support for genetic IQ theories |
182 |
|
-- Diminishing environmental influence |
183 |
|
-{{/expandable}} |
184 |
|
- |
185 |
|
-{{expandable summary="π Download"}} |
186 |
|
-[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]] |
187 |
|
-{{/expandable}} |
188 |
|
- |
189 |
|
-{{/expandable}} |
190 |
|
-{{/example}} |
191 |
|
-{{/expandable}} |
192 |
|
- |
193 |
|
----- |
194 |
|
- |
195 |
|
-== Bonus: Boilerplate Example Template == |
196 |
|
- |
197 |
|
-{{expandable summary="π Example Macro Template (`/example`)"}} |
198 |
|
-{{example}} |
199 |
|
-{{example}} |
200 |
|
-Your macro goes here. |
201 |
|
-{{/example}} |
202 |
|
-{{/example}} |
203 |
|
-{{/expandable}} |
204 |
|
- |
|
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. |