Guide for Formatting Wiki Articles in Chinese-Forums

[muyongshi]

When adding substantial amount of new material, it is recommended that you save it in a text file on your computer first, in case the website or your browser malfunctions.

[noparse]Texts within “[ ]”, such as [h2], , and , are vBulletin formatting codes.[/noparse] See FAQ for more details on the formatting codes available.

See NuWiki Syntax Guide for more Wiki structural formatting codes.

Use [noparse][h2], [h3], ..., [h7] heading format code for section headings, with [h2] being the biggest heading, [h7] being the smallest[/noparse]. Once you have four or more headings in an article, a table of content will automatically be displayed.

Section Title:

[noparse][h2]Title[/h2][/noparse]

Subsections Title:

[noparse][h3]Sub-Section Title[/h3][/noparse]

Main Content will use plain text and will not be separated from sub-section title unless it is a list.

If creating a list or points use bullets

[noparse][list][*]Point one

[*]point two
[/list][/noparse]

If the list contains a main content and sub-content the main content will be bolded and the sub-content will be placed in the next line italicized

[noparse][list][*]Point one
[i]sub-content[/i]

[*]point two
[/list][/noparse]

Explanation on a point should be placed in a new line with no formatting:

[noparse][list][*]Point one
[i]sub-content[/i]
Explanation or other information

[*]point two
[/list][/noparse]

Review your work, and take care that the spacing between sections are consistent.

If you would like to link to a discussion in the forums as a reference please add a footnote

[noparse][footnote]place text with link here[/footnote]
[/noparse]

[muyongshi]

I already did these changes in the dictionaries section so you can see what it looks like in case it isn't too clear...

[roddy]

Very good. Probably worth pointing out that this isn't compulsory - it's a guide, but if anyone wants to just type up stuff in any format that's still good - we can get one of our Wiki Editors to tidy it up later.

[muyongshi]

Obviously we can't force people to do it but it sure helps if things look uniform...

But those of us who are anal about it can just tidy up as it bugs us!

(I know I need )

[gato]

You can use [noparse][noparse][/noparse][/noparse] to force the forum software to show the vbCode.

By the way, there are more extensive Wiki formatting codes available that we might consider using at some point. See NuWiki Syntax Guide for how to add table of content and section links to your article.

[muyongshi]

I knew there was a way but it has been 2 years since I last actively did html encoding. Need to refresh myself!

If we get to the point where we need them we can definitely use them...my main concern is uniformity and just the readability of it.

[gato]

Oh, if you use the [noparse][h1], [h2], ..., [h7][/noparse] heading formatting code, a table of content is automatically created once you have more than 4 headings. The NuWiki syntax guide has more details.

See the new Dictionaries article using the heading codes.

Want to revise the formatting guide to take account of this?

[roddy]

Yep, that's what I did here. The style on that box might need tweaking though . . .

[muyongshi]

But they look so ugly! We need to start on a lower heading number then because starting with h1 is just to large. h2 is even pushing it!

[roddy]

Hit edit on the article I did above and see how that works, using the equals sign to format headings. To be honest I can't remember how I did it, but it seems to have auto-generated the content box ok.

[muyongshi]

That's what I'm doing now and just playing around with it now. If the largest we use is h2 then it will be fine I think (h2 directly corresponds to ==) but now the problem is that it puts huge gaps in between the headings unless you put them on the same line which that just creates hassle. I guess it will have to do as it is the most convenient way to create these tables...

[roddy]

Well I should be able to make CSS changes on the back end to get it looking how we want. What changes do you reckon need to be made?

[gato]

Simplified the formatting guide to reflect the new style.

[muyongshi]

When I get around to it

[muyongshi]

Dang you beat me!

[muyongshi]

Well I should be able to make CSS changes on the back end to get it looking how we want. What changes do you reckon need to be made?

Can you tell me what the font sizes are preset to now from h1 down to h4 or h5.

Also if we could reduce the spacing in between each header that would be great.

A general rule in page layout (more familiar with that than HTML) is your H1 and H2 should have no larger than a 2 pt. reduction in size and then after that no more than a 1 pt reduction per header and usually by the time you get to H3 or H4 you are at a 12pt font

so

H1=16pt

h2=14pt

h3=13pt

h4=12pt

etc.

You usually will not get down to that many points and actually after h4 you may not reduce the font size just change style.

Of course Style changes work great in the h1-h4 as well...

[gato]

Currently, there seems to be two blank spaces between h1 and h2. Should be just one or maybe 1.5. That may also be the case between the other headings.