Difference between revisions of "DFM Guideline: Copyediting checklist"

From DFM Wiki
(Imported guideline document from Word)
 
(Updated slightly to make this relevant to the e-book and to the current Working Papers editing workflow.)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<!DOCTYPE html>
+
''These instructions are for copy editing reports and working papers for publication by the Dried Fish Matters project. Most points will also apply to the e-book and other outputs.''
<html class="client-nojs" lang="en-CA" dir="ltr">
 
<head>
 
<meta charset="UTF-8"/>
 
<title>DFM Knowledge Base</title>
 
<script>document.documentElement.className="client-js";RLCONF={"wgBreakFrames":!1,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"YAC0kpvgp6teJi5rJhV5KQAAnwY","wgCSPNonce":!1,"wgCanonicalNamespace":"","wgCanonicalSpecialPageName":!1,"wgNamespaceNumber":0,"wgPageName":"Main_Page","wgTitle":"Main Page","wgCurRevisionId":14,"wgRevisionId":14,"wgArticleId":1,"wgIsArticle":!0,"wgIsRedirect":!1,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgPageContentLanguage":"en-ca","wgPageContentModel":"wikitext","wgRelevantPageName":"Main_Page","wgRelevantArticleId":1,"wgIsProbablyEditable":!1,"wgRelevantPageIsProbablyEditable":!1,"wgRestrictionEdit":[],"wgRestrictionMove":[],"wgIsMainPage":!0,"wgMediaViewerOnClick":!0,"wgMediaViewerEnabledByDefault":!0,
 
"wgVisualEditor":{"pageLanguageCode":"en-CA","pageLanguageDir":"ltr","pageVariantFallbacks":"en-ca"},"egMapsScriptPath":"/kb/extensions/Maps/","egMapsDebugJS":!1,"egMapsAvailableServices":["leaflet","googlemaps3"],"egMapsLeafletLayersApiKeys":{"MapBox":"","MapQuestOpen":"","Thunderforest":"","GeoportailFrance":""},"wgEditSubmitButtonLabelPublish":!1};RLSTATE={"site.styles":"ready","noscript":"ready","user.styles":"ready","user":"ready","user.options":"loading","ext.visualEditor.desktopArticleTarget.noscript":"ready","mediawiki.skinning.content.externallinks":"ready","skins.timeless":"ready"};RLPAGEMODULES=["site","mediawiki.page.startup","mediawiki.page.ready","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","skins.timeless.js","skins.timeless.mobile"];</script>
 
<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.implement("user.options@1hzgi",function($,jQuery,require,module){/*@nomin*/mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"});mw.user.options.set({"variant":"en-ca"});
 
});});</script>
 
<link rel="stylesheet" href="/kb/load.php?lang=en-ca&amp;modules=ext.visualEditor.desktopArticleTarget.noscript%7Cmediawiki.skinning.content.externallinks%7Cskins.timeless&amp;only=styles&amp;skin=timeless"/>
 
<script async="" src="/kb/load.php?lang=en-ca&amp;modules=startup&amp;only=scripts&amp;raw=1&amp;skin=timeless"></script>
 
<!--[if IE]><link rel="stylesheet" href="/kb/skins/Timeless/resources/IE9fixes.css?ffe73" media="screen"/><![endif]-->
 
<meta name="generator" content="MediaWiki 1.35.1"/>
 
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes, minimum-scale=0.25, maximum-scale=5.0"/>
 
<link rel="shortcut icon" href="/favicon.ico"/>
 
<link rel="search" type="application/opensearchdescription+xml" href="/kb/opensearch_desc.php" title="DFM Knowledge Base (en-ca)"/>
 
<link rel="EditURI" type="application/rsd+xml" href="https://driedfishmatters.org/kb/api.php?action=rsd"/>
 
<link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"/>
 
<link rel="alternate" type="application/atom+xml" title="DFM Knowledge Base Atom feed" href="/kb/index.php?title=Special:RecentChanges&amp;feed=atom"/>
 
<!--[if lt IE 9]><script src="/kb/resources/lib/html5shiv/html5shiv.js"></script><![endif]-->
 
</head>
 
<body class="mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-0 ns-subject page-Main_Page rootpage-Main_Page skin-timeless action-view"><div id="mw-wrapper"><div id="mw-header-container" class="ts-container"><div id="mw-header" class="ts-inner"><div id="user-tools"><div id="personal"><h2><span>Anonymous</span></h2><div id="personal-inner" class="dropdown"><div role="navigation" class="mw-portlet" id="p-personal" aria-labelledby="p-personal-label"><h3 id="p-personal-label" lang="en-CA" dir="ltr">Not logged in</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"><li id="pt-createaccount"><a href="/kb/index.php?title=Special:CreateAccount&amp;returnto=Main+Page" title="You are encouraged to create an account and log in; however, it is not mandatory"><span>Create account</span></a></li><li id="pt-login"><a href="/kb/index.php?title=Special:UserLogin&amp;returnto=Main+Page" title="You are encouraged to log in; however, it is not mandatory [o]" accesskey="o"><span>Log in</span></a></li></ul></div></div></div></div></div><div id="p-logo-text" class="mw-portlet" role="banner"><a id="p-banner" class="mw-wiki-title long" href="/kb/index.php?title=Main_Page">DFM Knowledge Base</a></div><div class="mw-portlet" id="p-search"><h3 lang="en-CA" dir="ltr"><label for="searchInput">Search</label></h3><form action="/kb/index.php" id="searchform"><div id="simpleSearch"><div id="searchInput-container"><input type="search" name="search" placeholder="Search DFM Knowledge Base" title="Search DFM Knowledge Base [f]" accesskey="f" id="searchInput"/></div><input type="hidden" value="Special:Search" name="title"/><input type="submit" name="fulltext" value="Search" title="Search the pages for this text" id="mw-searchButton" class="searchButton mw-fallbackSearchButton"/><input type="submit" name="go" value="Go" title="Go to a page with this exact name if it exists" id="searchButton" class="searchButton"/></div></form></div></div><div class="visualClear"></div></div><div id="mw-header-hack" class="color-bar"><div class="color-middle-container"><div class="color-middle"></div></div><div class="color-left"></div><div class="color-right"></div></div><div id="mw-header-nav-hack"><div class="color-bar"><div class="color-middle-container"><div class="color-middle"></div></div><div class="color-left"></div><div class="color-right"></div></div></div><div id="menus-cover"></div><div id="mw-content-container" class="ts-container"><div id="mw-content-block" class="ts-inner"><div id="mw-content-wrapper"><div id="mw-content"><div id="content" class="mw-body" role="main"><div class="mw-indicators mw-body-content">
 
</div>
 
<h1 id="firstHeading" class="firstHeading">Main Page</h1><div id="bodyContentOuter"><div id="siteSub">From DFM Knowledge Base</div><div id="mw-page-header-links"><div role="navigation" class="mw-portlet tools-inline" id="p-namespaces" aria-labelledby="p-namespaces-label"><h3 id="p-namespaces-label" lang="en-CA" dir="ltr">Namespaces</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"><li id="ca-nstab-main" class="selected"><a href="/kb/index.php?title=Main_Page" title="View the content page [c]" accesskey="c"><span>Main page</span></a></li><li id="ca-talk" class="new"><a href="/kb/index.php?title=Talk:Main_Page&amp;action=edit&amp;redlink=1" rel="discussion" title="Discussion about the content page (page does not exist) [t]" accesskey="t"><span>Discussion</span></a></li></ul></div></div><div role="navigation" class="mw-portlet tools-inline" id="p-more" aria-labelledby="p-more-label"><h3 id="p-more-label" lang="en-CA" dir="ltr">More</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"><li id="ca-more" class="dropdown-toggle"><span>More</span></li><li id="ca-languages" class="dropdown-toggle"><span>Languages</span></li></ul></div></div><div role="navigation" class="mw-portlet tools-inline" id="p-views" aria-labelledby="p-views-label"><h3 id="p-views-label" lang="en-CA" dir="ltr">Page actions</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"><li id="ca-view" class="selected"><a href="/kb/index.php?title=Main_Page"><span>Read</span></a></li><li id="ca-viewsource"><a href="/kb/index.php?title=Main_Page&amp;action=edit" title="This page is protected.&#10;You can view its source [e]" accesskey="e"><span>View source</span></a></li><li id="ca-history"><a href="/kb/index.php?title=Main_Page&amp;action=history" title="Past revisions of this page [h]" accesskey="h"><span>History</span></a></li></ul></div></div></div><div class="visualClear"></div><div class="mw-body-content" id="bodyContent"><div id="contentSub"></div><div id="mw-content-text" lang="en-CA" dir="ltr" class="mw-content-ltr"><div class="mw-parser-output"><p>The Dried Fish Matters Knowledge Base is an open platform for the creation and sharing of knowledge about dried fish in South and South-East Asia. It is part of the research initiative "<a rel="nofollow" class="external text" href="https://driedfishmatters.org">Dried Fish Matters: Mapping the social economy of dried fish in South and Southeast Asia for enhanced wellbeing and nutrition</a>", funded by the <a rel="nofollow" class="external text" href="https://sshrc-crsh.gc.ca/">Social Sciences and Humanities Research Council</a> of Canada.
 
</p>
 
<h2><span class="mw-headline" id="Contributing_to_the_DFM_Knowledge_Base">Contributing to the DFM Knowledge Base</span></h2>
 
<p>This system operates on <a href="https://www.mediawiki.org/wiki/MediaWiki" class="extiw" title="mediawikiwiki:MediaWiki">MediaWiki</a>, the same software that powers Wikipedia and many other sites. To contribute, simply <a href="/kb/index.php?title=Special:UserLogin" title="Special:UserLogin">log in</a> (or <a href="/kb/index.php?title=Special:CreateAccount" title="Special:CreateAccount">create an account</a>) and click/tap on the "edit" tab at the top of any page. You will need to confirm the email address associated with your account before editing.
 
</p><p>Anyone is welcome to contribute to the knowledge base, however <i>we will remove content that is unrelated to dried fish.</i>
 
</p>
 
<!--
 
NewPP limit report
 
Cached time: 20210114211556
 
Cache expiry: 86400
 
Dynamic content: false
 
Complications: []
 
CPU time usage: 0.026 seconds
 
Real time usage: 0.027 seconds
 
Preprocessor visited node count: 3/1000000
 
Post‐expand include size: 0/2097152 bytes
 
Template argument size: 0/2097152 bytes
 
Highest expansion depth: 2/40
 
Expensive parser function count: 0/100
 
Unstrip recursion depth: 0/20
 
Unstrip post‐expand size: 0/5000000 bytes
 
-->
 
<!--
 
Transclusion expansion time report (%,ms,calls,template)
 
100.00%    0.000      1 -total
 
-->
 
  
<!-- Saved in parser cache with key ethrift_wiki:pcache:idhash:1-0!canonical and timestamp 20210114211556 and revision id 14
+
Use the “track changes” feature to create a record of your edits. You do not need to leave comments justifying your changes, unless they substantially modify the text or request further information.
-->
+
 
</div></div><div class="printfooter">
+
Except where inconsistent with the requirements below, the document style should conform to the ''Chicago Manual of Style'', 17th edition: <nowiki>https://www-chicagomanualofstyle-org.uml.idm.oclc.org</nowiki>. We are using author-date format for citations.
Retrieved from "<a dir="ltr" href="https://driedfishmatters.org/kb/index.php?title=Main_Page&amp;oldid=14">https://driedfishmatters.org/kb/index.php?title=Main_Page&amp;oldid=14</a>"</div>
+
 
<div class="visualClear"></div></div></div></div></div><div id="content-bottom-stuff"><div id="catlinks" class="catlinks catlinks-allhidden" data-mw="interface"></div></div></div><div id="mw-site-navigation"><div id="p-logo" class="mw-portlet" role="banner"><a class="mw-wiki-logo fallback" href="/kb/index.php?title=Main_Page" title="Visit the main page"></a></div><div id="site-navigation" class="sidebar-chunk"><h2><span>Navigation</span></h2><div class="sidebar-inner"><div role="navigation" class="mw-portlet" id="p-navigation" aria-labelledby="p-navigation-label"><h3 id="p-navigation-label" lang="en-CA" dir="ltr">Navigation</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"><li id="n-mainpage-description"><a href="/kb/index.php?title=Main_Page" title="Visit the main page [z]" accesskey="z"><span>Main page</span></a></li><li id="n-recentchanges"><a href="/kb/index.php?title=Special:RecentChanges" title="A list of recent changes in the wiki [r]" accesskey="r"><span>Recent changes</span></a></li><li id="n-randompage"><a href="/kb/index.php?title=Special:Random" title="Load a random page [x]" accesskey="x"><span>Random page</span></a></li><li id="n-help-mediawiki"><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents"><span>Help about MediaWiki</span></a></li></ul></div></div></div></div><div id="site-tools" class="sidebar-chunk"><h2><span>Wiki tools</span></h2><div class="sidebar-inner"><div role="navigation" class="mw-portlet" id="p-tb" aria-labelledby="p-tb-label"><h3 id="p-tb-label" lang="en-CA" dir="ltr">Wiki tools</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"><li id="t-specialpages"><a href="/kb/index.php?title=Special:SpecialPages" title="A list of all special pages [q]" accesskey="q"><span>Special pages</span></a></li></ul></div></div></div></div></div><div id="mw-related-navigation"><div id="page-tools" class="sidebar-chunk"><h2><span>Page tools</span></h2><div class="sidebar-inner"><div role="navigation" class="mw-portlet emptyPortlet" id="p-cactions" aria-labelledby="p-cactions-label"><h3 id="p-cactions-label" lang="en-CA" dir="ltr">Page tools</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"></ul></div></div><div role="navigation" class="mw-portlet emptyPortlet" id="p-userpagetools" aria-labelledby="p-userpagetools-label"><h3 id="p-userpagetools-label" lang="en-CA" dir="ltr">Userpage tools</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"></ul></div></div><div role="navigation" class="mw-portlet" id="p-pagemisc" aria-labelledby="p-pagemisc-label"><h3 id="p-pagemisc-label" lang="en-CA" dir="ltr">More</h3><div class="mw-portlet-body"><ul lang="en-CA" dir="ltr"><li id="t-whatlinkshere"><a href="/kb/index.php?title=Special:WhatLinksHere/Main_Page" title="A list of all wiki pages that link here [j]" accesskey="j"><span>What links here</span></a></li><li id="t-recentchangeslinked"><a href="/kb/index.php?title=Special:RecentChangesLinked/Main_Page" rel="nofollow" title="Recent changes in pages linked from this page [k]" accesskey="k"><span>Related changes</span></a></li><li id="t-print"><a href="javascript:print();" rel="alternate" title="Printable version of this page [p]" accesskey="p"><span>Printable version</span></a></li><li id="t-permalink"><a href="/kb/index.php?title=Main_Page&amp;oldid=14" title="Permanent link to this revision of the page"><span>Permanent link</span></a></li><li id="t-info"><a href="/kb/index.php?title=Main_Page&amp;action=info" title="More information about this page"><span>Page information</span></a></li><li id="t-pagelog"><a href="/kb/index.php?title=Special:Log&amp;page=Main+Page"><span>Page logs</span></a></li></ul></div></div></div></div></div><div class="visualClear"></div></div></div><div id="mw-footer-container" class="mw-footer-container ts-container"><div id="mw-footer" class="mw-footer ts-inner"><div id="footer-bottom" class="mw-footer" role="contentinfo" lang="en-CA" dir="ltr"><div id="f-copyrightico" class="footer-icons"><a href="https://creativecommons.org/licenses/by-sa/4.0/"><img src="/kb/resources/assets/licenses/cc-by-sa.png" alt="Creative Commons Attribution-ShareAlike" width="88" height="31" loading="lazy"/></a></div><div id="f-poweredbyico" class="footer-icons"><a href="https://www.mediawiki.org/"><img src="/kb/resources/assets/poweredby_mediawiki_88x31.png" alt="Powered by MediaWiki" srcset="/kb/resources/assets/poweredby_mediawiki_132x47.png 1.5x, /kb/resources/assets/poweredby_mediawiki_176x62.png 2x" width="88" height="31" loading="lazy"/></a></div><ul id="f-list" class="footer-places"><li id="lastmod"> This page was last edited on 11 January 2021, at 20:27.</li><li id="copyright">Content is available under <a class="external" rel="nofollow" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike</a> unless otherwise noted.</li></ul><div class="visualClear"></div></div></div></div></div><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgPageParseReport":{"limitreport":{"cputime":"0.026","walltime":"0.027","ppvisitednodes":{"value":3,"limit":1000000},"postexpandincludesize":{"value":0,"limit":2097152},"templateargumentsize":{"value":0,"limit":2097152},"expansiondepth":{"value":2,"limit":40},"expensivefunctioncount":{"value":0,"limit":100},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":0,"limit":5000000},"timingprofile":["100.00%    0.000      1 -total"]},"cachereport":{"timestamp":"20210114211556","ttl":86400,"transientcontent":false}}});});</script><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgBackendResponseTime":520});});</script></body></html>
+
❏    Complete the metadata on the cover page/front matter (for a Working Paper: title, report type, institutional logo, document title, abstract, date, author, and other contributors; for an e-book chapter: title, authors, author affiliations), or leave a comment indicating information that is incomplete.  
 +
 
 +
❏    Correct errors of spelling and punctuation.  
 +
 
 +
❏    Correct obvious grammatical errors.
 +
 
 +
❏    Ensure terminological consistency (“dried fish” vs. “dry fish”, “small fish” vs. “small-sized fish”).
 +
 
 +
❏    Ensure that acronyms are defined on first usage.
 +
 
 +
❏    Put quotations longer than a sentence in blockquote format.
 +
 
 +
❏    Break up or rewrite sentences for clarity as needed, without modifying the overall content (generally: correct basic stylistic problems, including incorrect word order or awkward phrasings used by non-native English writers).
 +
 
 +
❏    Identify sentences or passages that do not make sense; use the comment feature to request clarification or additional information.
 +
 
 +
❏    Conform to Canadian spelling conventions.
 +
 
 +
❏    Apply heading styles (1-3) to section titles, ensuring that the document follows a hierarchical structure.
 +
 
 +
❏    Ensure headings are in sentence case.
 +
 
 +
❏    Create table titles and figure captions with numbers (e.g., Figure 1. Table 7.) Captions go below and titles above the element.
 +
 
 +
❏    Ensure a source is indicated in table and figure captions, using the format Source: <citation>.
 +
 
 +
❏    Cross-reference tables and figures (fig. x, table y) using the built-in referencing tool. Ensure that each figure and table is referenced at least once in the body of the text.
 +
 
 +
❏    Normalize capitalization and formatting of special terms (lowercase except for proper nouns; do not use italics or bold typeface for non-English or technical terms). (e.g., prahok vs. ''prahok'')
 +
 
 +
❏    Remove non-semantic direct formatting (bold, underlined, italic text; changes of typeface).
 +
 
 +
❏    Ensure citations are connected to items in the DFM Zotero library (as Zotero fields); items missing from the Zotero library should be added and tagged @cited-<document>. Note that non-academic sources, such as web pages and reports, should also be cited using the author-date format rather than as footnotes or as bare URLs.
 +
 
 +
❏    Ensure the bibliography generated by Zotero is correct; if not, adjust the metadata within the Zotero library.
 +
 
 +
❏    Check hyperlinks for correctness.
 +
 
 +
❏    Adjust positioning of tables, images, etc. to avoid orphaned or widowed elements.
 +
 
 +
❏    Check for excess whitespace, tabs, page and section breaks.
 +
 
 +
❏    Update the table of contents.
 +
 
 +
[[Category:DFM Guidelines]]
 +
[[Category:Featured]]

Latest revision as of 12:10, 29 March 2022

These instructions are for copy editing reports and working papers for publication by the Dried Fish Matters project. Most points will also apply to the e-book and other outputs.

Use the “track changes” feature to create a record of your edits. You do not need to leave comments justifying your changes, unless they substantially modify the text or request further information.

Except where inconsistent with the requirements below, the document style should conform to the Chicago Manual of Style, 17th edition: https://www-chicagomanualofstyle-org.uml.idm.oclc.org. We are using author-date format for citations.

❏    Complete the metadata on the cover page/front matter (for a Working Paper: title, report type, institutional logo, document title, abstract, date, author, and other contributors; for an e-book chapter: title, authors, author affiliations), or leave a comment indicating information that is incomplete.

❏    Correct errors of spelling and punctuation.

❏    Correct obvious grammatical errors.

❏    Ensure terminological consistency (“dried fish” vs. “dry fish”, “small fish” vs. “small-sized fish”).

❏    Ensure that acronyms are defined on first usage.

❏    Put quotations longer than a sentence in blockquote format.

❏    Break up or rewrite sentences for clarity as needed, without modifying the overall content (generally: correct basic stylistic problems, including incorrect word order or awkward phrasings used by non-native English writers).

❏    Identify sentences or passages that do not make sense; use the comment feature to request clarification or additional information.

❏    Conform to Canadian spelling conventions.

❏    Apply heading styles (1-3) to section titles, ensuring that the document follows a hierarchical structure.

❏    Ensure headings are in sentence case.

❏    Create table titles and figure captions with numbers (e.g., Figure 1. Table 7.) Captions go below and titles above the element.

❏    Ensure a source is indicated in table and figure captions, using the format Source: <citation>.

❏    Cross-reference tables and figures (fig. x, table y) using the built-in referencing tool. Ensure that each figure and table is referenced at least once in the body of the text.

❏    Normalize capitalization and formatting of special terms (lowercase except for proper nouns; do not use italics or bold typeface for non-English or technical terms). (e.g., prahok vs. prahok)

❏    Remove non-semantic direct formatting (bold, underlined, italic text; changes of typeface).

❏    Ensure citations are connected to items in the DFM Zotero library (as Zotero fields); items missing from the Zotero library should be added and tagged @cited-<document>. Note that non-academic sources, such as web pages and reports, should also be cited using the author-date format rather than as footnotes or as bare URLs.

❏    Ensure the bibliography generated by Zotero is correct; if not, adjust the metadata within the Zotero library.

❏    Check hyperlinks for correctness.

❏    Adjust positioning of tables, images, etc. to avoid orphaned or widowed elements.

❏    Check for excess whitespace, tabs, page and section breaks.

❏    Update the table of contents.