Author Instructions: Difference between revisions - Compendium of Cancer Genome Aberrations

(10 intermediate revisions by 2 users not shown)

Line 6:

#Pages in need of authors can be found here: [[Volunteer Assignments and Opportunities]] (''see “Authors” column and look for any that are not assigned''; every attempt is made to keep this updated).

#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. If the trainee needs help identifying a mentor, one can be provided upon request.

#We will be creating content for all entities with genetic findings in the current WHO Classification of Tumours books. ~~Therefore, if there~~ is ~~an entity not yet listed that you would like~~ to ~~author~~, ~~we would be happy to create a page for you now~~.

#We will be creating content for all entities with genetic findings in the current WHO Classification of Tumours books. This content is meant to be multi-sourced, including referencing the latest literature, guidelines, etc.

#For diseases that are present in multiple WHO books, our goal is to have ~~a main~~ page for a disease entity from ~~one~~ book (the primary book is selected based on being the most relevant), ~~and then the pages for the same entity in~~ other ~~books would refer~~ to that page ~~plus have their book-specific (''i.e.,'' body site) content. It is appreciated if the same author could volunteer for the related pages~~.

#For diseases that are present in multiple WHO books, our goal is to have one page for a disease entity from a primary book (the primary book is selected based on being the most relevant for that disease), with related content from other body sites also added to that page.

*For pages that do not yet have any content, authors will be connected by the Editor-in-Chief with an Associate Editor based on their disease section(s) of interest.

Line 17:

*Pages are based on current WHO entries and contain pre-loaded templates. Authors can work directly on the CCGA site. Authors can instead use a Word template (see section below to download; 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 two types of pages currently needing authors:

*There are two disease types of pages currently needing authors:

#~~Disease category overview~~ pages (for ~~example see [[Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms|~~~~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 often be completed by Associate Editors but can be authored by others if interested.

#Somatic disease-specific pages, which includes detailed genetic information for individual somatic disease entities.

~~#Disease-specific pages (for example see any links on the AML page~~), ~~which is for individual disease entities~~ and ~~much more detailed.~~

#Genetic tumor syndrome-specific pages, which includes detailed genetic information for individual genetic tumor syndrome entities.

#Gene-specific pages ~~(these pages~~ are in the process of being automated for data import ~~and~~ not requiring new authors at this time).

*Of note, other page types include, "Disease category overview pages", which are summaries of a group of diseases with links to all other relevant content (these will often be completed by Associate Editors but can be authored by others if interested), and "Gene-specific pages", which are in the process of being automated for data import (not requiring new authors at this time).

*For more details on how you use the site to be an author, please watch an instructional video (see section below).

Line 36:

Line 37:

*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".

#If present at the top of the page, 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.

Line 60:

Line 61:

6) The information to be included in CCGA is focused on clinically relevant content on the genetics of each disease (''i.e.,'' what would you want to know to write a clinical report).

7) While there is other information on the page such as morphologic features to give an overview of each disease, the main focus is to write a thorough summary of the clinically relevant genetic information.

7) Even if you're not a primary author on a page, please do update any page that has an inaccuracy or for which you've found additional useful content. This is a living crowdsourced wiki!

8) Even if you're not a primary author on a page, please do update any page that has an inaccuracy or for which you've found additional useful content. This is a living crowdsourced wiki!

==Video Tutorial==

*A video tutorial on how to author in real-time an overview or disease entity-specific page is available: ~~[[Video Tutorial|~~Video ~~Tutorial~~]]. Revised videos for the recently updated templates will be available in the near future.

*A video tutorial on how to author in real-time an overview or disease entity-specific page is available: [[Video Tutorials]]. Revised videos for the recently updated templates will be available in the near future.

==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|left|thumb|Disease-~~Specific~~ Template]].

*For a Word document template for authoring a '''somatic disease-specific page''' before transferring content online please see [[File:Somatic Disease Template Word Version with Instructions (6-6-2025).docx|left|thumb|Somatic Disease Template|link=Special:FilePath/Somatic Disease Template.docx]].

*For a Word document template for authoring a '''genetic tumor syndrome-specific page''' before transferring content online please see [[File:Genetic_Tumor_Syndromes_Template_Word_Version_with_Instructions (11-7-24).docx|left|thumb|Genetic Tumor Syndrome Template]].

*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|none|thumb|Disease Overview Template]].

@@ Line 6: / Line 6: @@
 #Pages in need of authors can be found here: <u>[[Volunteer Assignments and Opportunities]]</u> (''see “Authors” column and look for any that are not assigned''; every attempt is made to keep this updated).
 #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.  If the trainee needs help identifying a mentor, one can be provided upon request.
-#We will be creating content for all entities with genetic findings in the current WHO Classification of Tumours books. Therefore, if there is an entity not yet listed that you would like to author, we would be happy to create a page for you now.
+#We will be creating content for all entities with genetic findings in the current WHO Classification of Tumours books.  This content is meant to be multi-sourced, including referencing the latest literature, guidelines, etc.
-#For diseases that are present in multiple WHO books, our goal is to have a main page for a disease entity from one book (the primary book is selected based on being the most relevant), and then the pages for the same entity in other books would refer to that page plus have their book-specific (''i.e.,'' body site) content. It is appreciated if the same author could volunteer for the related pages.
+#For diseases that are present in multiple WHO books, our goal is to have one page for a disease entity from a primary book (the primary book is selected based on being the most relevant for that disease), with related content from other body sites also added to that page.
 *For pages that do not yet have any content, authors will be connected by the Editor-in-Chief with an Associate Editor based on their disease section(s) of interest.
@@ Line 17: / Line 17: @@
 *Pages are based on current WHO entries and contain pre-loaded templates.  Authors can work directly on the CCGA site.  Authors can instead use a Word template (see section below to download; 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 two types of pages currently needing authors:
+*There are two disease types of pages currently needing authors:
-#<u>Disease category overview pages</u> (for example see [[Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms|<u>Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms</u>]]), which are summaries of a group of diseases with links to all other relevant content.  These will often be completed by Associate Editors but can be authored by others if interested.
+#<u>Somatic disease-specific pages</u>, which includes detailed genetic information for individual somatic disease entities.
-#<u>Disease-specific pages</u> (for example see any links on the AML page), which is for individual disease entities and much more detailed.
+#<u>Genetic tumor syndrome-specific pages</u>, which includes detailed genetic information for individual genetic tumor syndrome entities.
-#Gene-specific pages (these pages are in the process of being automated for data import and not requiring new authors at this time).
+*Of note, other page types include, "Disease category overview pages", which are summaries of a group of diseases with links to all other relevant content (these will often be completed by Associate Editors but can be authored by others if interested), and "Gene-specific pages", which are in the process of being automated for data import (not requiring new authors at this time).
 *For more details on how you use the site to be an author, please watch an instructional video (see section below).
@@ Line 36: / Line 37: @@
 *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".
+#If present at the top of the page, 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.
@@ Line 60: / Line 61: @@
 ) The information to be included in CCGA is focused on clinically relevant content on the genetics of each disease (''i.e.,'' what would you want to know to write a clinical report).
-) While there is other information on the page such as morphologic features to give an overview of each disease, the main focus is to write a thorough summary of the clinically relevant genetic information.
+) Even if you're not a primary author on a page, please do update any page that has an inaccuracy or for which you've found additional useful content. This is a living crowdsourced wiki!
-) Even if you're not a primary author on a page, please do update any page that has an inaccuracy or for which you've found additional useful content. This is a living crowdsourced wiki!
 ==Video Tutorial==
-*A video tutorial on how to author in real-time an overview or disease entity-specific page is available: [[Video Tutorial|<u>Video Tutorial</u>]]. Revised videos for the recently updated templates will be available in the near future.
+*A video tutorial on how to author in real-time an overview or disease entity-specific page is available: <u>[[Video Tutorials]]</u>. Revised videos for the recently updated templates will be available in the near future.
 ==Word Version Templates==
-*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 a <u>'''somatic disease-specific page'''</u> before transferring content online please see   [[File:Somatic Disease Template Word Version with Instructions (6-6-2025).docx|left|thumb|Somatic Disease Template|link=Special:FilePath/Somatic Disease Template.docx]].
+*For a Word document template for authoring a <u>'''genetic tumor syndrome-specific page'''</u> before transferring content online please see [[File:Genetic_Tumor_Syndromes_Template_Word_Version_with_Instructions (11-7-24).docx|left|thumb|Genetic Tumor Syndrome 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]].