GOAT logo

Join the conversation! The forum activity is now at GOATeach.org!  We are working to cross pollinate our conversations. Document and share tools at farm hack and talk at GOAT!  Also join GOAT riot and introduce yourself and your projects!

  1. Forums
  2. Tool Forums
  3. Tool wiki template
  4. Use pound signs instead of font tags for section dividing

Use pound signs instead of font tags for section dividing

R.J. Steinert's picture
Submitted by R.J. Steinert on Tue, 04/17/2012 - 6:26pm
Topic Type: 
Idea

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
Submitted by dorn on Tue, 04/17/2012 - 8:29pm

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
Submitted by R.J. Steinert on Tue, 04/17/2012 - 8:57pm

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
Submitted by R.J. Steinert on Tue, 04/17/2012 - 9:00pm

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
Submitted by dorn on Tue, 04/17/2012 - 9:32pm

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
Submitted by R.J. Steinert on Tue, 04/17/2012 - 9:45pm
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.