Details pages -- conventions: Difference between revisions

From Genecats
Jump to navigationJump to search
(changing old 80 char to width limit to new 100 char width)
(made a few things less verbose, reordered/reworded, added a few notes)
Line 5: Line 5:
To ease the burden on QA, developers are requested to:
To ease the burden on QA, developers are requested to:


#  Keep lines in the source page to 100 characters or less.
#  Quotes, ampersands, and less than and greater than signs should be represented with their [[http://www.ascii.cl/htmlcodes.htm html names]].
#  Email addresses should go through Hiram's sanitizer (encodeEmail.pl). It turns the address into an encrypted HREF "mailto:" address that makes it harder for spammers to use.
#  The "Display Conventions and Configuration" section should cover all track types.
#  For ENCODE tracks, the page should include contact information for the submitting lab.


<B>Grammar/punctuation notes:</B>


#  html docs should conform to 100 char width (used to be 80-char width, but this has been changed).
#  Units should be separated from the numbers by a space:  "200 bp", not "200bp".
#  Units are separated from the numbers by a space:  "200 bp", not "200bp".
#  We are using data as a plural noun.  "Data are" not "Data is."
#  We are using data as a plural noun.  "Data are" not "Data is." It may seem awkward at first, but you'll get used to it.
#  "It's" means "It is."  "Its" is possessive.
#  "It's" means "It is."  "Its" is possessive.  It's not that hard to keep grammar in its place, if you think about it.
#  "Display Conventions and Configuration" section should cover all track types.
#  For ENCODE tracks, the page should include contact information for the submitting lab.


<B>Refs</B>
<B>References</B>


#  All references to websites not in our domain require the TARGET = _BLANK tag.  We simply have to add it if y'all don't.
#  All references to websites not in our domain require the TARGET = _BLANK tag.
#  Papers are referenced with outlinks in one place at the bottom of the page only, not in the text above.  In the text we simply say something like "Euskirchen, <EM> et al.</EM>, 2007".  Particularly if the paper is in preprint or Epub, we then only have to change the ref in one place.
#  Papers are referenced with outlinks in one place at the bottom of the page only, not in the text above.  In the text we simply say something like "Euskirchen, <EM> et al.</EM>, 2007".  Particularly if the paper is in preprint or Epub, we then only have to change the ref in one place.
#  Refs are in PubMed format (see [[CBSE_citation_format]]).
#  Refs are in PubMed format (see [[CBSE_citation_format]]).
#  Refs with many authors are truncated to 10 authors and et al. (ital).
#  Refs with many authors are truncated to 10 authors and ''et al'' (which should be italicized).
#  Refs are in alphabetical order by first author's last name.

Revision as of 02:47, 4 August 2011


Details pages should be consistent from track to track. To ease the burden on QA, developers are requested to:

  1. Keep lines in the source page to 100 characters or less.
  2. Quotes, ampersands, and less than and greater than signs should be represented with their [html names].
  3. Email addresses should go through Hiram's sanitizer (encodeEmail.pl). It turns the address into an encrypted HREF "mailto:" address that makes it harder for spammers to use.
  4. The "Display Conventions and Configuration" section should cover all track types.
  5. For ENCODE tracks, the page should include contact information for the submitting lab.

Grammar/punctuation notes:

  1. Units should be separated from the numbers by a space: "200 bp", not "200bp".
  2. We are using data as a plural noun. "Data are" not "Data is."
  3. "It's" means "It is." "Its" is possessive.

References

  1. All references to websites not in our domain require the TARGET = _BLANK tag.
  2. Papers are referenced with outlinks in one place at the bottom of the page only, not in the text above. In the text we simply say something like "Euskirchen, et al., 2007". Particularly if the paper is in preprint or Epub, we then only have to change the ref in one place.
  3. Refs are in PubMed format (see CBSE_citation_format).
  4. Refs with many authors are truncated to 10 authors and et al (which should be italicized).
  5. Refs are in alphabetical order by first author's last name.
Retrieved from "https://genomewiki.ucsc.edu/genecats/index.php?title=Details_pages_--_conventions&oldid=436"