Citation Markup Assistant testing

From PKP Wiki
Jump to: navigation, search

The Citation Markup Assistant includes four general components that need to be tested: the configuration component; the author input component; the editorial use component; and the output component. Each component includes embedded documentation to help you -- please let us know if any of the instructions are unclear.

Test by following the steps below:

Step 1: Configuration

You can configure the Citation Markup Assistant in Journal Setup Step 3.7. You will need to configure the following:

  • Citation Extraction Services: add, edit/configure, and delete various citation extraction services
  • Citation Checking Services: add, edit/configure, and delete various citation checking services
  • Citation Output: choose between various citation outputs.

You may need additional configuration information to properly configure some of the extraction and checking services. Feel free to use the following information:

  • Crossref Database Connector: you can use for the CrossRef registration email.
  • PubMed Database Connector: you can use for the PubMed registration email.

Additionally, if you are testing this on a server you do not have command-line access to (eg. the testing server) you may not be able to complete any configuration steps as outlined in the configuration instructions. However, if you are testing this on your own server, please go through with these configuration steps.

Make sure to save your work at the bottom of the setup page.

Step 2: Author Reference inputting

Log in as an Author, and start a new submission from the Author's User Home page.

During Step 3 of the submission process, you will be asked to submit a formatted list of references: do so by either using the included list of references, or preferably by submitting a unique list (which can be grabbed from an already-existing journal, or what have you).

Complete the submission process.

Step 3: Editorial use of the Citation Markup Assistant

Log in as an Editor, and view the submission that you previously submitted as an Author (which is most likely in your Unassigned queue).

From the submission's Summary page, you will see a new "References" tab link next to the "Editing" or "References" tab link (depending on whether journal history tracking has been configured). Click the "References" tab link.

You should be presented with an introductory message to using the Citation Markup Assistant, which will explain how to use it. Follow the instructions, keeping in mind that you want to approve citations and export them in a format of your choice. The tool includes instructions to help you on your way; if the instructions are not clear, or if you find that you have encountered a bug or unexpected behaviour, please let us know.

Step 4: Export of citations

As an Editor: once all citations have been approved, you should be able to export them in various formats. Following the instructions, export them into the galley filetype that you normally choose.

Further Steps

It is important to test as many different use cases as possible. Please consider testing under the following conditions:

1. Testing with different configuration options: try configuring the three Citation Markup Assistant configuration steps differently to see how the Assistant behaviour behaves.

2. Testing with different citation inputs: as part of the Author submission process, try adding different citations, and even broken/malformed citations to the Reference field, to test the extraction and parsing results.

3. Testing with different browsers: try configuring and using the Assistant with as many different browsers as possible: Internet Explorer 7 and 8; Firefox 2 and 3; Safari 3 and 4; Chrome; Opera; etc.

4. Testing as a Copy Editor: the above instructions suggest that you log in as an Editor to use the tool. You can also assign a Copy Editor to work with the submission, and the Copy Editor will have access to the Assistant. (You will need to enable separate Copy Editors under Journal Setup Step 4.5).