Associate Editor Instructions: Difference between revisions - Compendium of Cancer Genome Aberrations

(15 intermediate revisions by the same user not shown)

Line 1:

==~~Instructions~~==

==Introduction==

*IMPORTANT: '''On the [[~~Volunteer Assignments and Opportunities~~]] Page, Track Progress in Real Time''' of assigning author to pages (pending) and completion of pages (complete) as well as the date you reviewed the page and any notes of importance such as "non-WHO entity page" or check permissions for a figure. ''Open spaces in your area on this spreadsheet will alert the Editor-in-Chief to continue connecting potential authors with you.''

*IMPORTANT: '''On the [[Volunteers]] Page, Track Progress in Real Time''' of assigning author to pages (pending) and completion of pages (complete) as well as the date you reviewed the page and any notes of importance such as "non-WHO entity page" or check permissions for a figure. Open spaces in your area on this spreadsheet will alert the Editor-in-Chief to continue connecting potential authors with you.

*'''Onboarding Process''':

*Authors who are interested in the area in which you're Associate Editor, will be connected with you for the following '''Onboarding Process''':

#~~New authors will complete~~ the '''[https://mms.cancergenomics.org/members/form.php?orgcode=CGC&fid=3830649 Volunteer Form]''' ~~(if you're contacted directly please inform the new volunteer to complete this form)~~.

#Ensure the new author has completed the '''[https://mms.cancergenomics.org/members/form.php?orgcode=CGC&fid=3830649 Volunteer Form]'''.

#~~The Editor-in-Chief will send~~ a ~~link~~ to the ~~'''~~[[~~Volunteer Assignments and Opportunities~~]]~~''' page for volunteers to select which content to complete (informing which Associate Editor will be involved)~~.

#Create a username and password for a new author (see section below). IMPORTANT: Add the information to the [[User Access Log]].

#~~The Editor-in-Chief will introduce by email the Associate Editor and the new author (and mentor if applicable), including standardized onboarding information such as referring~~ them to the [[Author Instructions]]~~. This email will be copied~~ to the ~~Technical Associate Editor~~, ~~triggering them~~ to ~~assign~~ CCGA ~~account credentials (username and password)~~ to the ~~new author~~.

#Refer them to the [[Author Instructions]], which contains information including links to the video tutorial, Word version of page templates, policy on figure inclusion, and how to cite CCGA pages.

#Once a page is assigned, ensure the author's name is added ~~both to the '''[[Volunteer Assignments and Opportunities]]''' page and~~ to the top of the ~~individual assigned~~ page to clarity ~~which pages are~~ in progress.

#Emphasize to authors to please use the supplied tables if applicable.

#Once a page is assigned, ensure the author's name is added to the top of the page for clarity that the page is in progress.

#If the author is a trainee, ensure they are working with a mentor or perform the mentor function if you're able to do so.

#Set up a reasonable due date for the author. For example, propose 4 weeks and if author agrees, send an Outlook invite for that due date that has a one week prior reminder prior to this deadline.

*After authors indicate a page is complete, '''~~Perform~~ Editorial Review~~~~''':~~~~

*After authors indicate a page is "complete", perform '''Editorial Review''':

#Review the content for accuracy and appropriate completeness.

Line 17:

Line 18:

#Ensure the authors have inserted references in the standard format using the PubMed extension.

#Ensure the under construction note at the top of the page has been removed.

#Ensure appropriate and helpful images are included. Note: [Mailto:Agiguere.hmr@ssss.gouv.qc.ca Amélie Giguère, Ph.D, FCCMG] has offered to provide images for rare chromosomal translocations in hematological malignancies and most anomalies in WHO 2017.

*Once ~~you~~ '''~~Complete Editorial Review~~ and ~~Approve a~~ Page~~'''~~:

*Once a page has completed content, '''Add Categories and Page Citation Information''':

#Add the ~~editorial review completion date to the [[Volunteer Assignments and Opportunities]]~~ page.

#Add the Categories so that this page is now linked to the searching functions on the homepage (see section below).

#Send an '''[Mailto:CCGA@cancergenomics.org Email]''' with the heading "Complete Page" and the page name or link in the text. This will alert the Editor-in-Chief and the Technical Associate Editor to perform additional tasks such as adding linking categories to the page.

~~==Technical Associate Editor-Specific Functions==~~

*'''Onboarding Process''':

#Following receipt of the Volunteer Form, assess appropriateness of volunteer and flag any concerns to the Editor-in-Chief (see "Policy for Granting of CCGA Contributor Access" section below). Transfer this information into the Google tracking spreadsheet.

~~#Following receipt of the Editor-in-Chief email connecting the new author~~ to the ~~Associate Editor, assign credentials (username and password) to the new author (see "How to Create a New User Account" section below). IMPORTANT: Add the information to the [[User Access Log]].~~

*

*'''After Editorial Review Completed Process''':

~~#Add Categories to the page to link~~ searching functions on the homepage (see ~~"How to Add Categories to a Page"~~ section below).

#Add the WHO copyright permission information for any disease overview page that shows WHO classification structure in the Notes section at the bottom (last entry). You must use wiki-specific syntax. Therefore, copy the following information using the wiki syntax in the "Edit source" tab, add it in the appropriate place near the bottom of the target page using the "Edit source" tab (make sure there's a space after the previous entry): <nowiki>*</nowiki>The hierarchical tumour classification structure displayed on this page is reproduced from the [https://tumourclassification.iarc.who.int/welcome/ WHO Classification of Tumours] with permission from the copyright holder, ©International Agency for Research on Cancer.

#Add the citation for the page in the Notes section at the bottom. For example: *''Citation of this Page'': Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), updated {{REVISIONMONTH}}/{{REVISIONDAY}}/{{REVISIONYEAR}}, <nowiki>https://www.ccga.io/index.php/Myeloid_Sarcoma</nowiki>. See this in action at the bottom of [[Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms|Example]].

##In order to have the updated section autopopulate on each page, you must use wiki-specific syntax. Therefore, copy this example from the "Edit source" tab and place it in the correct location on the target page using the "Edit" tab or manually type or paste in the yellow highlighted text below.

[[File:Citing page image.png|center|thumb|alt=]]

*'''Add WHO Copyright Information''':

#Add the WHO copyright permission information for any disease overview page that shows WHO classification structure in the Notes section at the bottom (last entry). You must use wiki-specific syntax. Therefore, copy the following information using the wiki syntax in the "Edit source" tab, add it in the appropriate place near the bottom of the target page using the "Edit source" tab (make sure there's a space after the previous entry): <nowiki>*</nowiki>The hierarchical tumour classification structure displayed on this page is reproduced from the [https://tumourclassification.iarc.who.int/welcome/ WHO Classification of Tumours] with permission from the copyright holder, ©International Agency for Research on Cancer.

==How to Create a New User Account==

@@ Line 1: / Line 1: @@
-==Instructions==
+==Introduction==
-*IMPORTANT: '''<u>On the [[Volunteer Assignments and Opportunities]] Page, Track Progress in Real Time</u>''' of assigning author to pages (pending) and completion of pages (complete) as well as the date you reviewed the page and any notes of importance such as "non-WHO entity page" or check permissions for a figure. ''Open spaces in your area on this spreadsheet will alert the Editor-in-Chief to continue connecting potential authors with you.''
+*IMPORTANT: '''<u>On the [[Volunteers]] Page, Track Progress in Real Time</u>''' of assigning author to pages (pending) and completion of pages (complete) as well as the date you reviewed the page and any notes of importance such as "non-WHO entity page" or check permissions for a figure. Open spaces in your area on this spreadsheet will alert the Editor-in-Chief to continue connecting potential authors with you.
-*<u>'''Onboarding Process'''</u>:
+*Authors who are interested in the area in which you're Associate Editor, will be connected with you for the following <u>'''Onboarding Process'''</u>:
-#New authors will complete the '''[https://mms.cancergenomics.org/members/form.php?orgcode=CGC&fid=3830649 <u>Volunteer Form</u>]''' (if you're contacted directly please inform the new volunteer to complete this form).
+#Ensure the  new author has completed the '''[https://mms.cancergenomics.org/members/form.php?orgcode=CGC&fid=3830649 <u>Volunteer Form</u>]'''.
-#The Editor-in-Chief will send a link to the '''<u>[[Volunteer Assignments and Opportunities]]</u>''' page for volunteers to select which content to complete (informing which Associate Editor will be involved).
+#Create a username and password for a new author (see section below).  IMPORTANT: Add the information to the [[User Access Log]].
-#The Editor-in-Chief will introduce by email the Associate Editor and the new author (and mentor if applicable), including standardized onboarding information such as referring them to the [[Author Instructions]]. This email will be copied to the Technical Associate Editor, triggering them to assign CCGA account credentials (username and password) to the new author.
+#Refer them to the [[Author Instructions]], which contains information including links to the video tutorial, Word version of page templates, policy on figure inclusion, and how to cite CCGA pages.
-#Once a page is assigned, ensure the author's name is added both to the '''<u>[[Volunteer Assignments and Opportunities]]</u>''' page and to the top of the individual assigned page to clarity which pages are in progress.
+#Emphasize to authors to please use the supplied tables if applicable.
+#Once a page is assigned, ensure the author's name is added to the top of the page for clarity that the page is in progress.
 #If the author is a trainee, ensure they are working with a mentor or perform the mentor function if you're able to do so.
 #Set up a reasonable due date for the author.  For example, propose 4 weeks and if author agrees, send an Outlook invite for that due date that has a one week prior reminder prior to this deadline.
-*After authors indicate a page is complete, '''<u>Perform Editorial Review</u>'''<u>:</u>
+*After authors indicate a page is "complete", perform <u>'''Editorial Review'''</u>:
 #Review the content for accuracy and appropriate completeness.
@@ Line 17: / Line 18: @@
 #Ensure the authors have inserted references in the standard format using the PubMed extension.
 #Ensure the under construction note at the top of the page has been removed.
-#Ensure appropriate and helpful images are included.  Note: [Mailto:Agiguere.hmr@ssss.gouv.qc.ca <u>Amélie Giguère, Ph.D, FCCMG</u>] has offered to provide images for rare chromosomal translocations in hematological malignancies and most anomalies in WHO 2017.
-*Once you '''<u>Complete Editorial Review and Approve a Page</u>''':
+*<u>Once a page has completed content, '''Add Categories and Page Citation Information'''</u>:
-#Add the editorial review completion date to the [[Volunteer Assignments and Opportunities]] page.
+#Add the Categories so that this page is now linked to the searching functions on the homepage (see section below).
-#Send an '''[Mailto:CCGA@cancergenomics.org <u>Email</u>]''' with the heading "Complete Page" and the page name or link in the text.  This will alert the Editor-in-Chief and the Technical Associate Editor to perform additional tasks such as adding linking categories to the page.
-==Technical Associate Editor-Specific Functions==
-*'''<u>Onboarding Process</u>''':
-#Following receipt of the Volunteer Form, assess appropriateness of volunteer and flag any concerns to the Editor-in-Chief (see "Policy for Granting of CCGA Contributor Access" section below). Transfer this information into the Google tracking spreadsheet.
-#Following receipt of the Editor-in-Chief email connecting the new author to the Associate Editor, assign credentials (username and password) to the new author (see "How to Create a New User Account" section below). IMPORTANT: Add the information to the [[User Access Log]].
-*
-*<u>'''After Editorial Review Completed Process'''</u>:
-#Add Categories to the page to link searching functions on the homepage (see "How to Add Categories to a Page" section below).
-#Add the WHO copyright permission information for any disease overview page that shows WHO classification structure in the Notes section at the bottom (last entry). You must use wiki-specific syntax.  Therefore, copy the following information using the wiki syntax in the "Edit source" tab, add it in the appropriate place near the bottom of the target page using the "Edit source" tab (make sure there's a space after the previous entry): <nowiki>*</nowiki>The hierarchical tumour classification structure displayed on this page is reproduced from the [https://tumourclassification.iarc.who.int/welcome/ WHO Classification of Tumours] with permission from the copyright holder, ©International Agency for Research on Cancer.
 #Add the citation for the page in the Notes section at the bottom.  For example: *''Citation of this Page'': Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), updated {{REVISIONMONTH}}/{{REVISIONDAY}}/{{REVISIONYEAR}}, <nowiki>https://www.ccga.io/index.php/Myeloid_Sarcoma</nowiki>.  See this in action at the bottom of [[Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms|Example]].
 ##In order to have the updated section autopopulate on each page, you must use wiki-specific syntax.  Therefore, copy this example from the "Edit source" tab and place it in the correct location on the target page using the "Edit" tab or manually type or paste in the yellow highlighted text below.
 [[File:Citing page image.png|center|thumb|alt=]]
+*<u>'''Add WHO Copyright Information'''</u>:
+#Add the WHO copyright permission information for any disease overview page that shows WHO classification structure in the Notes section at the bottom (last entry).  You must use wiki-specific syntax.  Therefore, copy the following information using the wiki syntax in the "Edit source" tab, add it in the appropriate place near the bottom of the target page using the "Edit source" tab (make sure there's a space after the previous entry): <nowiki>*</nowiki>The hierarchical tumour classification structure displayed on this page is reproduced from the [https://tumourclassification.iarc.who.int/welcome/ WHO Classification of Tumours] with permission from the copyright holder, ©International Agency for Research on Cancer.
 ==How to Create a New User Account==