Pub Management

Reference for managing, sharing, and reviewing your pub.
Dec 28, 2018chevron-down
1 Discussion (#public)
1 Contributor
Pub Management

Pubs can be managed by clicking the options button.


Configure Pub details, including social sharing.

Use: Make changes and click save details to save your changes.


  • Title: The title that will display for your Pub on PubPub, in exports, in RSS, in search results, and on social media.

  • Link: The end of the url that will be used to link to your pub. No special characters or spaces are allowed. Warning: Changing the link will cause old links you have previously sent to collaborators to fail.

  • Description: The description or subhead for your Pub on PubPub, in exports, in RSS, in search results, and on social media.

  • Pub Image: The image that will display on social media and in search results.

  • Use Header Image: Sets the image you uploaded in Pub Image to be displayed as the header image on PubPub.


Set the tags the Pub is associated with. Adding tags to a Pub may change where it is displayed on your community, depending on how you have setup your Pages.

Use: Start typing your tags into the dialog box. Tag addition, removal, and creation is automatically saved.


  • Add an existing tag to your Pub: Search for its nam and click on it in the dropdown that appears.

  • Create a new tag and add it to your Pub: Type a new tag and click on the dropdown that says “Create new tag: your tag name.”

  • Remove a tag from your Pub: Click the x to the left of the tag in the tag list.


Sharing controls who can see, edit, and comment on versions of your Pubs. This is how you manage collaboration and publishing.


Pub managers have the ability to manage every aspect of the Pub, including the ability to see all versions, create new versions, change the title and other details, manage tags, manage reviews, manage attribution, manage discussion channels, add new collaborators and managers, and even delete the Pub.

Use: Click the community admin checkbox or start typing a manager’s name in the add manager input box. Adding community admins and setting their permissions is automatically saved.


  • Community admins can manage: allows all community admins to manage the Pub. Default: true.

Version Permissions

Versions control how others can read, review, and edit Pubs. The working draft is the live, editable version of the Pub. If there are multiple public versions of the Pub, PubPub will say “(Default Public Version)” next to the version that public visitors will see.

New public and private versions are saved using the save version button at the top of the Pub Editor.

Use: Click on the version you want to modify and use the permissions dropdown to set permissions for each version. Start typing a user’s name in the add user input box and use the permissions dropbox by their name to control their access. Setting version permissions, adding users, and setting user permissions is automatically saved.


  • Working draft: Private (only Pub Managers and added contributors can read and edit), Public view (anyone can read, but only Pub Managers and added contributors can edit), Public Edit (anyone can read and edit). Default: Private.

  • Other versions: Private (only Pub Managers and added contributors can read), Public (anyone can read).


Review is an experimental feature that is not yet suited for widespread use, but can be used to track and keep a log of review status. Note: this status log is not exposed publicly, but is visible to all Pub Managers.

Use: As an author or Pub Manager, select a version to submit for review in the select a version dropdown and click the submit version for review button. Community managers can then add a message or select from the options to change the review status.


  • Submit a message: typing in the add a message to submission box and clicking the update status or add message button adds a messages to the review without updating the status.

  • Closed: sets the review status to closed. To continue review, authors would need to re-submit a version for review.

  • Accepted: sets the review status to accepted. Authors can submit new versions for review if they make changes.

  • Rejected: sets the status to rejected. To continue review, authors would need to re-submit a version for review.

  • Changes requested: sets the status to changes requested and prompts the author to submit a new version.


Pubs can be assigned a DOI via CrossRef. Once the DOI is assigned, each article version is assigned a component DOI. The main DOI always points to the latest Public version of the Pub.

Use: Click the Assign DOI button. DOI is automatically generated and saved. Future component DOIs are automatically generated and saved on version creation.


Deleting a Pub is permanent and cannot be undone.

Use: Delete the pub by typing its title in the box and clicking delete.


Attribution controls who is publicly credited for creating the pub. This is different than many other collaborative text editors, where attribution is automatically given when users are given access to the document. Contributors appear in the sidebar of PubPub.

Use: Start typing a contributor’s name in the add new person input box. Click on their name when it appears to add them to the contributor list. Contributors are automatically saved.


  • Contributor ordering: drag contributors from the drag icon. Contributors will show in the order you set both in the sidebar and, for byline contributors, in the byline on PubPub and exports, and in author lists in citations, repositories and social media.

  • List on byline: shows the contributor in the byline on PubPub and exports, and as the author in citations, repositories, and social media. Default: false.

  • Roles: adds a role to the sidebar of PubPub. Choose from the existing list or create a new role by typing it and clicking the role in the dropdown. Default: none


Discussion channels are collections of discussions that can be used to segment discussions into multiple different types. Channel moderators can edit, re-title, and archive comments. By default, all Pubs come with a public discussion channel and community admins can moderate that channel.

Use: Create a new channel typing its name in the new discussion channel title input box and typing enter. Remove channels by clicking the archive channel button. Change permissions using the permissions dropdown. Add participants by typing their name into the add participant to #channel input box and clicking on it from the dropdown that appears.


  • Private: allows only named participants (and community managers, if selected) to view and create comments in the channel.

  • Public: allows anyone to view and create comments in the channel.

  • Restricted: allows anyone to view comments in the channel, but only named participants (and community managers, if selected) to create comments in the channel.

  • Archive channel: makes channels no longer visible to anyone, even explicitly shared users.

  • Unarchive channel: makes archived channels visible according to their permissions settings.

  • Community admin can moderate: allows community admins to edit, re-title, archive comments, change channel permissions, and add new channel participants. Default: true.

  • Add channel participant: adds a participant to the channel with given permissions.

  • Channel participant can moderate: allows the named participant to edit, re-title, archive comments, change channel permissions, and add new channel participants.

Importing and Exporting

PubPub supports auto-generated importing and exporting from the following formats: PDF, Microsoft Word, Markdown, EPub, HTML, OpenDocument, Plain Text, JATS XML, and LaTeX. This feature is considered experimental, as not all formats support all of PubPub’s rich media options.

Use: To import, visit a blank Pub, click the import button, and choose your file from the dialog box that appears. To export, click Export in the sidebar or options panel. Then, choose the format you wish to export to and click the export button.

Import/Export Feature Support Status:

The current import/export support status is maintained in this spreadsheet.


Creating collections and managing them
RAJESH VENKATACHALAPATHY: How do I create collections from an available pool of pubs?