Difference between revisions of "Adding a Reference"

From Cybersecurity Wiki
Jump to: navigation, search
(4.3 Categorization)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''To add a new bibliographic reference entry:'''
+
{{Header_Message|message=This page is undergoing revision, thank you for your patience.}}
 +
 
 +
<!--'''To add a new bibliographic reference entry:'''
  
 
=== 1. Research the Reference ===
 
=== 1. Research the Reference ===
Line 9: Line 11:
  
 
=== 3. Create a blank Wiki page for the reference ===
 
=== 3. Create a blank Wiki page for the reference ===
To do this within the wiki format, you need to choose an existing page to create the link.  Normally, you will enter it into the listing of all references on the [[Cybersecurity Annotated Bibliography]].  Enter a new table entry in the correct alphabetical order by first (if more than one) author's last name (see next paragraph). The initial entry does not have to be complete (since some information will not yet be available such as level of expertise), however leave blank table entries ("|  |") for missing data.
+
To do this within the wiki format, you need to choose an existing page to create the link on.  Normally, you will enter the reference into the listing of all references on the [[Cybersecurity Annotated Bibliography]].  Enter a new table entry in the correct alphabetical order by first (if more than one) author's last name (see next paragraph). The initial entry does not have to be complete (since some information will not yet be available such as level of expertise), however leave blank table entries ("|  |") for missing data.
  
The title of the new reference page will normally be the short version of the reference title.  For  
+
'''The title of the new reference page will normally be the short version of the reference title.''' For  
 
example, if the title of the reference is "''Pricing Security: Vulnerabilities as Externalities'',"  
 
example, if the title of the reference is "''Pricing Security: Vulnerabilities as Externalities'',"  
 
the page will be named [[Pricing Security]].  The exception will be where that page already exists  
 
the page will be named [[Pricing Security]].  The exception will be where that page already exists  
 
([[Cyberwar]] for example), in which case you will need to include the subtitle (or some other distinguishing text) to create a unique page name.
 
([[Cyberwar]] for example), in which case you will need to include the subtitle (or some other distinguishing text) to create a unique page name.
  
Clicking on your newly created link will open a blank editing page (if it does not then you need to  
+
'''Click on your newly created link.''' This should open a blank editing page (if it does not then you need to  
come up with a new unique page name).  Copy and paste the contents of the [[TemplateForSources | sample template]]  
+
come up with a new unique page name).   
 +
 
 +
'''Copy and paste''' the contents of the [[TemplateForSources | sample template]]  
 
or some other reference page similar to the new reference into the newly created page.  You should  
 
or some other reference page similar to the new reference into the newly created page.  You should  
 
copy the ''source'' of the template (by selecting the "edit" tab) rather than the displayed page text.
 
copy the ''source'' of the template (by selecting the "edit" tab) rather than the displayed page text.
Line 27: Line 31:
 
The "Full Title of Reference" should contain both the main title and any subtitle separated by a colon.
 
The "Full Title of Reference" should contain both the main title and any subtitle separated by a colon.
  
e.g, Even though the wiki reference page is [[Four Grand Challenges in Trustworthy Computing]], the full title would be "Four Grand Challenges in Trustworthy Computing: Second in a Series of Conferences on Grand Research Challenges in Computer Science and Engineering."
+
E.g, Even though the wiki reference page is [[Four Grand Challenges in Trustworthy Computing]], the full title would be "Four Grand Challenges in Trustworthy Computing: Second in a Series of Conferences on Grand Research Challenges in Computer Science and Engineering."
  
 
==== 4.2 Full Citation ====
 
==== 4.2 Full Citation ====
Line 56: Line 60:
 
Note: ''Categories refer to the major themes of the reference.''  If the reference only mentions a category in passing but does not focus on it, then it need not be included.
 
Note: ''Categories refer to the major themes of the reference.''  If the reference only mentions a category in passing but does not focus on it, then it need not be included.
  
Create links to the appropriate categories for the reference.  When you add a link to a category to the reference page, you must also place a link back to the reference page  
+
'''Create links to the appropriate categories for the reference.''' When you add a link to a category to the reference page, you must also place a link back to the reference page  
 
into the [[Table of Contents]] page for that category and ''every Table of Contents page higher in the hierarchy''.  So, for example, if you categorize the reference  
 
into the [[Table of Contents]] page for that category and ''every Table of Contents page higher in the hierarchy''.  So, for example, if you categorize the reference  
 
under TOC-> Issues-> Economics of Cybersecurity->Insurance, then links to it must appear under [[Insurance]], [[Economics of Cybersecurity]] and [[Issues]].  Links from
 
under TOC-> Issues-> Economics of Cybersecurity->Insurance, then links to it must appear under [[Insurance]], [[Economics of Cybersecurity]] and [[Issues]].  Links from
 
TOC Category pages back to the reference page should follow the table format shown in the TOC.  If more than two authors, abbreviate to "<first author> et. al"
 
TOC Category pages back to the reference page should follow the table format shown in the TOC.  If more than two authors, abbreviate to "<first author> et. al"
  
Enter the reference in the selected category page in alphabetical order by the [first] author's last name.
+
'''Enter the reference in the selected category page''' in alphabetical order by the [first] author's last name.
  
 
Categories should be separated by top level Table of Contents topics and in the following order (note only those top level topics in which the current reference has an applicable category need appear), i.e.:
 
Categories should be separated by top level Table of Contents topics and in the following order (note only those top level topics in which the current reference has an applicable category need appear), i.e.:
Line 76: Line 80:
  
 
==== 4.4 Key Words ====
 
==== 4.4 Key Words ====
Add Glossary/Keyword entries in alphabetical order separated by commas.  You can copy links from the [[List of Keyword links to copy into reference pages | Keyword Links]] page directly into the reference page.  (Switch to "edit" mode to copy the link -- be careful not to change the text on the Keyword Links page though.) Make sure to create links from the [[Keyword Index and Glossary of Core Ideas]] page back to the reference.  If another reference by the same author
+
'''Add Relevant Keywords:''' Add Glossary/Keyword entries in alphabetical order separated by commas.  You can copy links from the [[List of Keyword links to copy into reference pages | Keyword Links]] page directly into the reference page.  (Switch to "edit" mode to copy the link -- be careful not to change the text on the Keyword Links page though.)  
is linked under a given keyword, use "[2]", "[3]", etc. for succeeding entries.
+
  
''Links to Keywords are appropriate even when the item is only mentioned in passing in the reference''.  The purpose of keywords are to help someone unfamiliar with the term or
+
'''In the glossary, create links back to the reference page:''' Make sure to create links from the [[Keyword Index and Glossary of Core Ideas]] page back to the reference.  If another reference by the same author is linked under a given keyword, use "[2]", "[3]", etc. for succeeding entries.
to provide a way to find other references with the same keyword but appearing in a separate category.
+
  
If you decide to add a new keyword to the [[Keyword Index and Glossary of Core Ideas]], make sure to update the [[List of Keyword links to copy into reference pages | Keyword Links]] page.  It is also a good idea to email either David Abrams or Caroline Nolan of the addition.
+
'''New keywords:''' If you decide to add a new keyword to the [[Keyword Index and Glossary of Core Ideas]], make sure to update the [[List of Keyword links to copy into reference pages | Keyword Links]] page.  It is also a good idea to email either David Abrams or Caroline Nolan of the addition.
 +
 
 +
Note that links to Keywords are appropriate ''even when the item is only mentioned in passing in the reference''.  The purpose of keywords are to help someone unfamiliar with the term or
 +
to provide a way to find other references with the same keyword but appearing in a separate category.
  
 
====4.5 Synopsis====
 
====4.5 Synopsis====
Add the Synopsis. The goal is not merely to summarize the subject matter of the reference; rather, the synopsis should also summarize the author's conclusions as well.  Typically this will be equivalent to an executive summary, and that section of the reference, if available, can provide the basis of the synopsis.  Alternately, quoted opening or conclusion paragraphs from the reference may form the basis for the synopsis.  Feel free to use wiki section headings "===", "====", etc. to provide clarity to the synopsis.
+
'''Add the Synopsis:''' The goal is not merely to summarize the subject matter of the reference; rather, the synopsis should also summarize the author's conclusions as well.  Typically this will be equivalent to an executive summary, and that section of the reference, if available, can provide the basis of the synopsis.  Alternately, quoted opening or conclusion paragraphs from the reference may form the basis for the synopsis.  Feel free to use wiki section headings "===", "====", etc. to provide clarity to the synopsis.
  
 
====4.6 Additional Notes and Highlights====
 
====4.6 Additional Notes and Highlights====
 
Finally, the "Additional Notes and Highlights" section provides a place to include information that does not fit in elsewhere.
 
Finally, the "Additional Notes and Highlights" section provides a place to include information that does not fit in elsewhere.
  
Required: This section should begin with "Expertise Required: " followed by either "None" or one or more "<field> - <level>" pair separated by semicolons.  Level is one of "Low", "Moderate" or "High" (although intermediate values "Low/Moderate" are allowed.  If there are multiple field/level pairs, order them from highest expertise level to lowest, e.g.,
+
'''Required:''' This section should begin with "Expertise Required: " followed by either "None" or one or more "<field> - <level>" pair separated by semicolons.  Level is one of "Low", "Moderate" or "High" (although intermediate values "Low/Moderate" are allowed.  If there are multiple field/level pairs, order them from highest expertise level to lowest, e.g.,
  
 
Expertise Required: Economics - Moderate; Law - Low
 
Expertise Required: Economics - Moderate; Law - Low
  
This is a subjective measure.  "None" means a person with a college education but no specific expertise in the subject matter of the reference would be able to understand it.  "High" suggests that a great deal of knowledge in the subject matter is required, possibly because of extensive mathematical equations or jargon filled discussion.
+
This is a subjective measure.  "None" means a person with a college education but no specific expertise in the subject matter of the reference would be able to understand it.  "High" suggests that a great deal of knowledge in the subject matter is required, possibly because of extensive mathematical equations or jargon-filled discussion.
  
 
(Note that on the reference page, each expertise entry is ordered with subject matter first followed by level required; however, in the TOC, the highest level of competence is always placed first to allow the user to sort on that parameter.)
 
(Note that on the reference page, each expertise entry is ordered with subject matter first followed by level required; however, in the TOC, the highest level of competence is always placed first to allow the user to sort on that parameter.)
  
Other possible items to include in the Additional Notes and Highlights if available are:
+
'''Other possible items to include in the Additional Notes and Highlights (if available) are:'''
  
* The table of contents of the reference: [[Overcoming Impediments to Information Sharing#Additional Notes and Highlights]].
+
* The '''table of contents''' of the reference: [[Overcoming Impediments to Information Sharing#Additional Notes and Highlights]].
  
* Biographic information about the author: [[Armed Attack in Cyberspace#Additional Notes and Highlights]] or about an organization [[Security Economics and the Internal Market#Additional Notes and Highlights]].
+
* '''Biographic information''' about the author: [[Armed Attack in Cyberspace#Additional Notes and Highlights]] or about an organization [[Security Economics and the Internal Market#Additional Notes and Highlights]].
  
* Reviews of the reference: [[Do Data Breach Disclosure Laws Reduce Identity Theft#Additional Notes and Highlights]].
+
* '''Reviews''' of the reference: [[Do Data Breach Disclosure Laws Reduce Identity Theft#Additional Notes and Highlights]].
  
* Excerpts or chapters where the full reference is not available online: [[Cyber War#Additional Notes and Highlights]].
+
* '''Excerpts''' or chapters where the full reference is not available online: [[Cyber War#Additional Notes and Highlights]].
  
* Links to the author's home page: [[Why Information Security is Hard#Additional Notes and Highlights]].
+
* Links to '''the author's home page''': [[Why Information Security is Hard#Additional Notes and Highlights]].
  
 
* "See also" information that would be useful to the reader:  [[Law and War in the Virtual Era#Additional Notes and Highlights]].
 
* "See also" information that would be useful to the reader:  [[Law and War in the Virtual Era#Additional Notes and Highlights]].
  
* Information on (and possibly links to) previous versions of the reference: [[A Roadmap for Cybersecurity Research#Additional Notes and Highlights]].
+
* Information on (and possibly links to) '''previous versions''' of the reference: [[A Roadmap for Cybersecurity Research#Additional Notes and Highlights]].
  
* Description of a useful appendix or glossary in the reference: [[Critical Infrastructure Threats and Terrorism#Additional Notes and Highlights]].
+
* Description of a '''useful appendix or glossary''' in the reference: [[Critical Infrastructure Threats and Terrorism#Additional Notes and Highlights]].
  
 
===5. Check your Work===
 
===5. Check your Work===
Line 122: Line 127:
 
* Make sure the reference appears in the selected categories and ''all the higher level categories'' of the selected categories.
 
* Make sure the reference appears in the selected categories and ''all the higher level categories'' of the selected categories.
 
* Make sure your category links not only work but properly link back to the reference.
 
* Make sure your category links not only work but properly link back to the reference.
* Make sure your keywords links not only work but properly link back to the reference.
+
* Make sure your keywords links not only work but properly link back to the reference.-->

Latest revision as of 17:30, 9 August 2012

This page is undergoing revision, thank you for your patience.