Use pound signs instead of font tags for section dividing

Topic Type:

The colors are nice in that they help the section headers pop out but I think it might be easier for folks working on documentation to use pound signs instead of font tags. Check out the original tool template wiki as an example.

@Dorn What do you think?

Dorn's picture

I agree that the html kind of makes editing a little more complex to edit, but I didn't think it would be too bad. Happy to back it off to other means to make the headers pop out a bit, and I agree we should work towards a standard look too. What do others think about colored section headings?

The difference in editing is

Header Text

or

Header Text

R.J. Steinert's picture

One advantage of using "#" to mark off headings is you can indicate subheadings using "##" and even deeper using "###".

This:

# 1 - Section 1
Some text.

## 1.1 - Subsection 1
Some text.

## 1.2 - Subsection 2
Some text.

### 1.2.1 - Sub-Subsection 1
Some text.

### 1.2.2 - Sub-Subsection 2

# 2 - Section 2
Some text.

## 2.1 - Subsection 1

And on and on....

Turns into this:

1 - Section 1

Some text.

1.1 - Subsection 1

Some text.

1.2 - Subsection 2

Some text.

1.2.1 - Sub-Subsection 1

Some text.

1.2.2 - Sub-Subsection 2

2 - Section 2

Some text.

2.1 - Subsection 1

And on and on....

R.J. Steinert's picture

I can also add some code to this website to make sure that every time pound signs are used for sectioning content that they get a specific color of our choosing.

Dorn's picture

Thanks - I think this is a helpful approach. I would maybe suggest we try going without color at first, and see what design folks would like to to do later. Could you add the above syntax to the Quick Tips? Any objection to using html color in forum posts?

R.J. Steinert's picture

Could you add the above syntax to the Quick Tips?

Good idea.

Any objection to using html color in forum posts?

Nope. No objections. I think the general consensus on the web is that color can be useful if used in a predictable way. It's when people start using color differently that it makes it hard to understand.