Details pages -- conventions: Difference between revisions

From genomewiki
Jump to navigationJump to search
No edit summary
m (list numbering and a couple new things)
Line 4: Line 4:
To ease the burden on QA, developers are requested to:
To ease the burden on QA, developers are requested to:


1.  html docs should conform to Jim's suggested 80-char width.
 
2.  Units are separated from the numbers by a space:  "200 bp", not
"200bp".
3.  We are using data as a plural noun.  "Data are" not "Data is."
It may sem awkward at first, but you'll get used to it.
4.  "It's" means "It is."  "Its" is possessive.  It's not that hard to
keep grammar in its place, if you think about it.




#  html docs should conform to Jim's suggested 80-char width.
#  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." It may seem awkward at first, but you'll get used to it.
#  "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>Refs</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.
5. All references to websites not in our domain require the TARGET = _BLANK
# 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.
tag.  We simply have to add it if y'all don't.
# Refs are in PubMed format (see [[CBSE_citation_format]]).
 
# Refs with many authors are truncated to 10 authors and et al. (ital).
 
6. 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.
7. Refs are in PubMed format.
 
8. Refs with many authors are truncated to 10 authors and et al. (ital).

Revision as of 18:31, 25 February 2009


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


  1. html docs should conform to Jim's suggested 80-char width.
  2. Units are separated from the numbers by a space: "200 bp", not "200bp".
  3. 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.
  4. "It's" means "It is." "Its" is possessive. It's not that hard to keep grammar in its place, if you think about it.
  5. "Display Conventions and Configuration" section should cover all track types.
  6. For ENCODE tracks, the page should include contact information for the submitting lab.

Refs

  1. All references to websites not in our domain require the TARGET = _BLANK tag. We simply have to add it if y'all don't.
  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. (ital).
Retrieved from "https://genomewiki.ucsc.edu/index.php?title=Details_pages_--_conventions&oldid=7301"