Difference between revisions of "Author Instructions"
Jump to navigation
Jump to search
[unchecked revision] | [checked revision] |
(27 intermediate revisions by one other user not shown) | |||
Line 5: | Line 5: | ||
*Authors will be given a username and password by the Associate Editor. | *Authors will be given a username and password by the Associate Editor. | ||
*Author names will be added to the top of any page(s) that they wish to complete so others know they’re in process. | *Author names will be added to the top of any page(s) that they wish to complete so others know they’re in process. | ||
− | *Pages are based on current WHO entries and contain pre-loaded templates (of note, if there’s a non-WHO entity of importance, a new page can be created). | + | *Pages are based on current WHO entries and contain pre-loaded templates (of note, if there’s a non-WHO entity of importance, a new page can be created). Authors are encouraged to work in Word templates (see section below; please track references by PMIDs as the site allows for automatic input of references based on PMIDs) and then copy/paste the content into the wiki site. |
*There are three types of pages: | *There are three types of pages: | ||
− | #Disease category overview pages (for example see [[Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms]], which are summaries of a group of diseases with links to all other relevant content. | + | #Disease category overview pages (for example see [[Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms]]), which are summaries of a group of diseases with links to all other relevant content. These will typically be completed by Associate Editors. |
#Disease-specific pages (for example see any links on the AML page), which is for individual disease entities and much more detailed. | #Disease-specific pages (for example see any links on the AML page), which is for individual disease entities and much more detailed. | ||
− | #Gene-specific pages (for example see [[ABL1]]) | + | #Gene-specific pages (for example see [[ABL1]]). |
− | *For more details on how you use the site to be an author, please see an instructional video (see section below). | + | *For more details on how you use the site to be an author, please see an instructional video (see section below). Of note, we highly encourage authors to populate all the tables (i.e. for immunophenotype, chromosomal rearrangements, genomic gain/loss/LOH, etc) when applicable. |
*For the timeline, there’s some flexibility and please work with your Associate Editor to set a target date. | *For the timeline, there’s some flexibility and please work with your Associate Editor to set a target date. | ||
+ | *Once a page is complete, please: | ||
+ | |||
+ | #Delete the statement "This page is under construction. We need you help! Please consider joining in the project and submitting a review". | ||
+ | #Email the appropriate Associate Editor that the page is complete. | ||
+ | |||
*Trainees are highly encouraged and welcome to participate in this effort. Trainees are asked to work with a mentor to help review their page content before completion. | *Trainees are highly encouraged and welcome to participate in this effort. Trainees are asked to work with a mentor to help review their page content before completion. | ||
− | *For any additional questions, please | + | *For any additional questions, please '''[Mailto:CCGA@cancergenomics.org <u>Contact us</u>]'''. If applicable, please include the disease category you are interested in working on in the subject line (''i.e.'' ALL, mature B-cell neoplasms, etc). |
+ | *For technical issues, please '''[Mailto:CCGA@cancergenomics.org <u>Contact us</u>]''' and include the title of the page on which the error occurred, a screenshot of the error message, the web browser you were using (i.e. firefox, google chrome, internet explorer, etc) and any other pertinent information. | ||
==Video Tutorial== | ==Video Tutorial== | ||
*A video tutorial on how to author in real-time an overview or disease entity-specific page is available: [[Video Tutorial]] | *A video tutorial on how to author in real-time an overview or disease entity-specific page is available: [[Video Tutorial]] | ||
− | |||
==Word Version Templates== | ==Word Version Templates== | ||
− | *For a Word document template for authoring a disease-specific page before transferring content online please | + | *For a Word document template for authoring a <u>'''disease-specific page'''</u> before transferring content online please see [[File:Disease or Entity-Specific Template Word Version with Instructions.docx|left|thumb|Disease-Specific Template]]. |
+ | |||
+ | *For a Word document template for authoring an <u>'''overview page'''</u> before transferring content online please see [[File:Disease Overview Template Word Version with Instructions.docx|none|thumb|Disease Overview Template]]. | ||
− | *For a Word document template for authoring | + | *For a Word document template for authoring a <u>'''gene-specific page'''</u> before transferring content online please see [[File:Gene-Specific Template Word Version with Instructions.docx|none|thumb|Gene-Specific Template]]. |
*Please do use the provided tables if applicable. | *Please do use the provided tables if applicable. | ||
Line 41: | Line 48: | ||
*<u>Citation for a CCGA page on an Author's CV</u>: | *<u>Citation for a CCGA page on an Author's CV</u>: | ||
− | #Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), created 2018 | + | #Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), created 06/23/2018, <nowiki>https://www.ccga.io/index.php/Myeloid_Sarcoma</nowiki>. |
*<u>Citation in Reports or Other Media</u>: | *<u>Citation in Reports or Other Media</u>: | ||
− | #Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), updated 2020 | + | #Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), updated 01/02/2020, <nowiki>https://www.ccga.io/index.php/Myeloid_Sarcoma</nowiki>. |
Revision as of 10:22, 7 November 2021
Introduction
Thank you for your interest in contributing to this community effort. Please find information below of potential use to you as an author.
- For pages that do not yet have any content, authors will be connected with an Associate Editor based on their disease section(s) of interest.
- Authors will be given a username and password by the Associate Editor.
- Author names will be added to the top of any page(s) that they wish to complete so others know they’re in process.
- Pages are based on current WHO entries and contain pre-loaded templates (of note, if there’s a non-WHO entity of importance, a new page can be created). Authors are encouraged to work in Word templates (see section below; please track references by PMIDs as the site allows for automatic input of references based on PMIDs) and then copy/paste the content into the wiki site.
- There are three types of pages:
- Disease category overview pages (for example see Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms), which are summaries of a group of diseases with links to all other relevant content. These will typically be completed by Associate Editors.
- Disease-specific pages (for example see any links on the AML page), which is for individual disease entities and much more detailed.
- Gene-specific pages (for example see ABL1).
- For more details on how you use the site to be an author, please see an instructional video (see section below). Of note, we highly encourage authors to populate all the tables (i.e. for immunophenotype, chromosomal rearrangements, genomic gain/loss/LOH, etc) when applicable.
- For the timeline, there’s some flexibility and please work with your Associate Editor to set a target date.
- Once a page is complete, please:
- Delete the statement "This page is under construction. We need you help! Please consider joining in the project and submitting a review".
- Email the appropriate Associate Editor that the page is complete.
- Trainees are highly encouraged and welcome to participate in this effort. Trainees are asked to work with a mentor to help review their page content before completion.
- For any additional questions, please Contact us. If applicable, please include the disease category you are interested in working on in the subject line (i.e. ALL, mature B-cell neoplasms, etc).
- For technical issues, please Contact us and include the title of the page on which the error occurred, a screenshot of the error message, the web browser you were using (i.e. firefox, google chrome, internet explorer, etc) and any other pertinent information.
Video Tutorial
- A video tutorial on how to author in real-time an overview or disease entity-specific page is available: Video Tutorial
Word Version Templates
- For a Word document template for authoring a disease-specific page before transferring content online please see File:Disease or Entity-Specific Template Word Version with Instructions.docx.
- For a Word document template for authoring an overview page before transferring content online please see File:Disease Overview Template Word Version with Instructions.docx.
- For a Word document template for authoring a gene-specific page before transferring content online please see File:Gene-Specific Template Word Version with Instructions.docx.
- Please do use the provided tables if applicable.
Policy for Inclusion of Figures on the CCGA Site
Use of illustrative figures on the Compendium of Cancer Genome Aberrations (CCGA) is encouraged. This policy defines the process for inclusion of a figure.
- For figures created by an individual or provided from their lab, the PHI must be removed and the submitter’s name and institution included in the figure legend.
- For figures from any other source (such as a website or published paper), a link to the image content, if openly accessible, can be used on the CCGA page. If such a link is not possible, written permission must be obtained by the person creating the CCGA page before addition to the page. This written permission should be shared with the Associate Editor of the related section and copied to ccga@cancergenomics.org. The figure legend should include the appropriate reference and confirmation that permission was obtained.
How to Cite CCGA Pages
- Citation for a CCGA page on an Author's CV:
- Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), created 06/23/2018, https://www.ccga.io/index.php/Myeloid_Sarcoma.
- Citation in Reports or Other Media:
- Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), updated 01/02/2020, https://www.ccga.io/index.php/Myeloid_Sarcoma.