About the PICUP Collection

Begin Authoring Become a Reviewer

Overview Review Process Review Criteria Authoring Guidelines Authoring Instructions

Authoring Instructions

Markdown:

Submissions to the PICUP Collection use a formatting language called Markdown. If you've never used Markdown before, you'll find that it's not that difficult to learn in a matter of minutes.  To familiarize yourself with Markdown, we recommend starting with the PICUP Markdown Test Site.  This site contains a description of the use of Markdown in the PICUP Collection and numerous examples that will be relevant to your authoring.  It also provides a "playground" where you can type markdown and equations (in the box on the left), and you will immediately see how they will be rendered online (in the box on the right). There are also buttons at the bottom of the page that will allow you to test how your markdown and equations will be rendered in MS Word and LaTeX.

Even if you are already familiar with Markdown, you should still visit the PICUP Markdown Test Site for a listing of things to look out for, which are listed under the sections Equation idiosyncrasies and Backslashes. If you would like a more general introduction to Markdown, we also recommend the interactive Markdown tutorial.

When you are ready to begin authoring, use the Begin Authoring button above which will take you to an online form.  The first step in the authoring process will be to enter some Preliminary Information, described below.   

Pages for Authoring:

When you begin the authoring process, the first page will require you to enter a few pieces of preliminary information, such as the submissions Title, Abbreviated Title, and URL Reference (described in the Guidelines tab).  This information is needed by the server in order to begin the process.

After saving your entries on the Preliminary Information page, you will be transported to another page for building your Exercise Set or Faculty Commons submission. The information that you previously entered is displayed at the top, along with other fields that need to be filled in. At the bottom of this page are three important buttons:

  • Save - Pressing this button saves all of your entries, but will keep you on the Exercise Set construction page (you can navigate away and come back to this page anytime to continue).
  • Save and View Web Layout - This button will only appear for Exercise Sets, not for Faculty Commons submissions. It is for checking your entries in the official web layout. Pressing this button saves your entries and then produces a view of how your entries will look online. Use this to check the view of your content at any time during the Exercise Set construction process.
  • Save and Continue - Pressing Save and Continue will save all of your entries, but will take you to the "Authoring Dashboard" where you can further manage all of your submissions to the PICUP Collection.

At any point, if you wish to continue working on authoring your submission while you do not have access to the internet, you can download your work as a ZIP file, which will allow you to work offline and then reimport the ZIP file later.  Just be careful:  If you make changes online and then reimport a ZIP file, any changes that you make online will be overwritten. A video showing this process will be forthcoming.

Submission for Editorial Review/Approval:

Once all required content is filled in, and all required uploads are complete, your contribution can be submitted for publication using the Authoring Dashboard. For an Exercise Set submission, this will begin the review process. For a Faculty Commons submission, there is not a peer review process, and your submission will be published online once it has been reviewed and approved by a PICUP Editor.  For additional details, please consult the Review Process and Review Criteria tabs.