Talk:Marking up

From BeebWiki

Jump to: navigation, search

Marking up code

Some articles use bold to mark up program code fragments within blocks of text, some articles use code block. Some articles even use both. For instance:

  • The first VALMID$ string is a series of initial start positions of the month name strings for each month. The second VALMID$ string is the length of each month name.
  • The first VALMID$ string is a series of initial start positions of the month name strings for each month. The second VALMID$ string is the length of each month name.
  • The first VALMID$ string is a series of initial start positions of the month name strings for each month. The second VALMID$ string is the length of each month name.

Which looks better?

The BBC BASIC for Windows Wiki uses bold for code fragments, for instance:

  • When using OPENIN, OPENUP and OPENOUT to create or access files that do not have a file extension
  • PROCScan_Dir("C:\Program Files") will recursively scan the C:\Program Files directory.

User:jgharston

Beardo

My days of advocacy long since past, :) I could be persuaded in favour of any one of the three, with a slight preference for (1). In my edits so far I tended to (2) i.e. VALMID$ simply to echo the style of the User Guide. I would hold out for monospaced text in code blocks, however:
0GOTOFNg(0)
1DEFFNg(?-1)P."I should loop forever, but I don't":=0
beardo 22:40, 25 July 2010 (UTC)

Bold Code

I've decided to go for bold code. I managed to dig out my old BBC User Guide and it has inline code. Looking at it, it seems rather indistinct, and comparing with the BB4W Wiki I think bold code comes across better.

User:jgharston

Personal tools