A Capability Maturity Model for Research Data Management
Main » How to Use This Site » Guide for Authors and Editors

Guide for Authors and Editors

Last modified by Arden Kirkland on 2014/03/19 18:08

Guide for Authors and Editors

Crowdsourced editing of the pages of this wiki will be deployed when a governance structure such as a review committee is established.

At such a time, this page will provide guidance for authors and editors.

For general help getting started with XWiki, start with http://enterprise.xwiki.org/xwiki/bin/view/GettingStarted/WebHome?version=5.1-milestone-1

Create a user account

Add a new page

  • from within the space in which you would like to add a new page, click on the green "Add" button on the very top left menu
    • "CMM for RDM" is the space for the wiki / model
    • "Blog" is the space for the blog
  • if you would like to change the page hierarchy, shown in the breadcrumb trail at the top, click on the hierarchy icon and make your changes
  • use the WYSIWYG editor to compose your page (follow the Style Guide below)
  • for advanced features, read about more advanced xwiki syntax
  • click on the button at the bottom to "Save & View"

Edit an existing page

  • from the page, click on "Edit" on the top left menu
  • use the WYSIWYG editor to make changes to your page (follow the Style Guide below)
  • for advanced features, read about more advanced xwiki syntax
  • at the bottom, under "Version Summary," describe the changes made, to be recorded in the version history
  • click on the button at the bottom to "Save & View"

Add Tags

  • scroll down to the bottom of the page
  • just above the comments area, at the bottom of the page text, there is a section for tags on the lower left
  • existing tags are shown there, and link to a list of other pages with the same tag
  • click on the "+" sign to add tags
  • separate multiple tags with commas
  • as you start to type, some suggested existing tags will appear as a drop down list
    • you can click to select from this list
    • or you can continue typing a new tag
  • click the "add" button to submit your tags

Style Guide

  • Follow the format of existing pages as much as possible!
  • References
    • Citations are listed under the heading "References" at the end of each section (not Works Cited or References Cited, etc.)
      • citations are in APA format
    • text includes parenthetical citations, which link to anchors in the references listed at the bottom of each page
    • Reference sections are not linked from the main table of contents, except for the full bibliography at the end.
    • Links to URLs are all visible, including both links in full citations and contextual links within the text
    • All full citations also listed in the site-wide bibliography, at the end of the model
  • Structure:
    • "X." sections are a brief introduction with a table of contents outline just for that section
      • "X." =  H1 header
      • References = H2 header
      • a brief text summarizes the context of each X. section
      • an overall goal is included at the top, in italics, ending with a period
      • the table of contents is outlined at the bottom
    • "X.X" sections include all sub-sections, with references at the end
      • "X.X" = H1 header
      • "X.X.X" = H2 header
      • "X.X.X.X" = H3 header
      • References = H2 header
      • a table of contents box is included at the very top right of the page
      • a brief introduction to the section appears in italics on the top left, consistent with the 4 key practice areas, with the term for the key practice area initially in bold
  • Links to next and previous pages are included at the very bottom of every page

XWiki Syntax Tips

  • To link to an anchor in the same page
    • ([[Hale et al., 2003>>||anchor="Hale"]])
  • To link to an anchor in another page (using headers)
    • ([[Hale et al., 2003>>url:http://rdm.ischool.syr.edu/xwiki/bin/view/CMM+for+RDM/1.1+#Hale]])
  • Syntax for the anchor itself
    • {{id name="Hale"/}}Hale, S. S., Miglarese, A. H., Bradley, M. P., Belton, T. J., Cooper, L. D., Frame, M. T., … Peterjohn, B. G. (2003). Managing Troubled Data: Coastal Data Partnerships Smooth Data Integration. //Environmental Monitoring and Assessment//, //81//(1-3), 133–148. doi:10.1023/A:1021372923589. Retrieved from [[http:~~/~~/link.springer.com/article/10.1023%2FA%3A1021372923589>>url:http://link.springer.com/article/10.1023%2FA%3A1021372923589||rel="__blank"]]
  • to export a PDF
    • 1 level of child pages: http://rdm.ischool.syr.edu/xwiki/bin/export/CMM+for+RDM/WebHome?format=pdf&includechilds=1
    • 2 levels of child pages: http://rdm.ischool.syr.edu/xwiki/bin/export/CMM+for+RDM/WebHome?format=pdf&includechilds=2

Other Notes

  • et al. is not preceded by a comma, and should always have the period after the "l"
Created by Arden Kirkland on 2014/02/03 17:54

XWiki Enterprise 5.1-milestone-1 - Documentation