Organizing Xwiki

Last modified by Justin Morgan on 2019/11/17 20:29

Headings


Headings should follow the following format rules:

H1=Bold, Horizontal Line below

H2=As-is

H3=As-is

H4=As-is

H5=As-is

H6=As-is

Code


How can I format text so it will appear as source code inline and in block? The "Formatted" paragraph format does not do the trick. Maybe I can use color? Do I have to use HTML/CSS for this? I feel like there should be a macro for this but I can't seem to find one.

TOC


Pages with 2 or more H1 headings should get a TOC, only displaying the H1 headings. See the below macro in its source format for how to set up the TOC. The floatinginfobox parameter will float the TOC box to the right of the page. The depth parameter when set to 1 will only show the H1 headings.

{{box cssClass="floatinginfobox"}}
{{toc depth=1 /}}
{{/box}}

There are other parameters that can be changed. For a full description of all parameters for the TOC macro, see this page.

Parent Only Pages


For pages that contain only a list of child pages with no additional information, use the Children macro. Ideally the macro would not require expanding longer lists of child pages, however, for the moment this may not be a setting that can be changed.

Templates


Templates needed: Project template, 

Things to consider for templates: What headings/sub-headings will be needed? What macros will be needed? Will it need a TOC? Will there be children?