User:CallerNo6/Web Service/testing: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
No edit summary
Line 59: Line 59:
| Language and script elements: class names, types, namespaces, attributes, methods, variables, keywords, functions, modules, commands, properties, parameters, values, objects, events, XML and HTML tags, and similar elements. Some examples include: System.Web.UI, a while loop, the Socket class, and the Obsolete attribute. Exception: commands in Unix, Oracle, SQL, and Linux book, which are regular italics. || <tt>Constant width</tt>
| Language and script elements: class names, types, namespaces, attributes, methods, variables, keywords, functions, modules, commands, properties, parameters, values, objects, events, XML and HTML tags, and similar elements. Some examples include: System.Web.UI, a while loop, the Socket class, and the Obsolete attribute. Exception: commands in Unix, Oracle, SQL, and Linux book, which are regular italics. || <tt>Constant width</tt>
|-
|-
| Replaceable items (placeholder items in syntax); “username” in the following example is a placeholder: login: username || ''<tt>Constant width italic</tt>''
| Replaceable items (placeholder items in syntax); “username” in the following example is a placeholder: "login: ''<tt>username</tt>''" || ''<tt>Constant width italic</tt>''
|-
|-
| Commands or text to be typed by the user || '''<tt>Constant width bold</tt>'''
| Commands or text to be typed by the user || '''<tt>Constant width bold</tt>'''

Revision as of 16:06, 4 July 2014

WTF?

This is a page for trying out typographic conventions.

Links

  • http://musicbrainz.org/ws/2/<entity> (italic)
  • http://musicbrainz.org/ws/2/<entity> (bold)
  • http://musicbrainz.org/ws/2/<entity> (bold italic)
  • http://musicbrainz.org/ws/2/<entity> (tt, should be fixed width)
  • http://musicbrainz.org/ws/2/<entity> (fixed width italic)
  • http://musicbrainz.org/ws/2/<entity> (fixed width bold)
  • http://musicbrainz.org/ws/2/<entity> (fixed width bold italic)
  • http://musicbrainz.org/ws/2/<entity> (fixed width w/ all italic, which is what the O'Reilly guide suggests but I don't think the replaceable text stands out enough this way)
  • http://musicbrainz.org/ws/2/<entity> (fixed width bold w/ all italic)


Entities in sentences?

  • An artist is not an artist. (tt)
  • An artist in not an artist. (tt italic)
  • an artist is not an artist (css font-family:monospace , should be fixed width but note it's smaller)

Monospace tests

  • OOOOOO

So, note. font-size:monospace will default (for most sytems) to smaller-than-body-text unless you put in a dummy font-family first. So:

<span style="font-family:mono-workaround, monospace;">Foo</span>

Code

from foo import bar

I don't like the gray.

from foo import bar

this is a block quote w/ monospace and a border just for kicks

<code>from markdown import code_block_style</code>

markdown uses <pre><code> to format code blocks

The O'Reilly way

from O'Reilly
Filenames, file extensions (such as .jpeg), directory paths, commands in Unix, Oracle, SQL, and Linux books Body font italic
URLs, URIs, email addresses Body font italic
Emphasized words (shouting!) Body font italic
First instance of a technical term Body font italic
Code blocks Constant width
Registry keys Constant width
Language and script elements: class names, types, namespaces, attributes, methods, variables, keywords, functions, modules, commands, properties, parameters, values, objects, events, XML and HTML tags, and similar elements. Some examples include: System.Web.UI, a while loop, the Socket class, and the Obsolete attribute. Exception: commands in Unix, Oracle, SQL, and Linux book, which are regular italics. Constant width
Replaceable items (placeholder items in syntax); “username” in the following example is a placeholder: "login: username" Constant width italic
Commands or text to be typed by the user Constant width bold
Line annotations Body font italic (but smaller)
Placeholders in paths, directories, GUI items, URLs, or other text that would be italic anyway http://www.<yourname>.com
Keyboard accelerators (Ctrl, Shift, etc.), menu titles, menu options, menu buttons Body text