Details pages -- conventions: Difference between revisions

From genomewiki
Jump to navigationJump to search
(New page: 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. Un...)
 
No edit summary
Line 11: Line 11:




3.  All references to websites not in our domain require the TARGET = _BLANK
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.
 
 
 
<B>Refs</B>
 
5.  All references to websites not in our domain require the TARGET = _BLANK
tag.  We simply have to add it if y'all don't.
tag.  We simply have to add it if y'all don't.


 
4.  Papers are referenced with outlinks in one place at the bottom of the
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
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  
"Euskirchen, <EM> et al.</EM>, 2007".  Particularly if the paper is in  
Line 21: Line 33:
   
   
   
   
5.  Refs are in PubMed format.
7.  Refs are in PubMed format.
   
   


6.  Refs with many authors are truncated to 10 authors and et al. (ital).
8.  Refs with many authors are truncated to 10 authors and et al. (ital).

Revision as of 01:40, 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 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.


Refs


5. All references to websites not in our domain require the TARGET = _BLANK tag. We simply have to add it if y'all don't.


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, et al., 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).