This is an old revision of the document!


Improve Zotero's Documentation

The Zotero project's success is anchored in its community. Community members help isolate bugs, guide development through feature requests, contribute program code and citation styles, and help write Zotero's documentation. This page describes how you can contribute to improving Zotero's documentation.

Creating a Wiki Account

Zotero's main source of documentation is the Zotero wiki. Like with Wikipedia, any (registered) user can edit, add to, and enhance the wiki. To create a wiki account go to the wiki registration page and sign up (a wiki account is not the same as a Zotero account).

Three Documentation Sections

The Zotero wiki is divided in three main sections:

The knowledge base (all the articles found at /support/kb) is used to discuss frequently asked questions, as well as the more esoteric subjects concerning Zotero. The tangential (and often brief) nature of these articles make them a great place to get familiar with documenting Zotero. If a question keeps coming up in the forums, start an article about it and link to it in future forum threads. To add a wiki page to the knowledge base, include the “kb” tag at the bottom of the page:

{{tag>kb}}

The general documentation, which functions as the Zotero manual, and contains core information about Zotero. Significant edits to this part of the wiki should be the result of community consensus.

The developers section, which provides technical information about the Zotero ecosystem. Its content ranges from details on how to modify and extend the core program, to instructions on how to writing web translators and citation styles.

Editing the Wiki

  • Logging in: You need to be logged in to the wiki to edit and create pages. You can log in from any page by appending ?do=login to the page's URL (e.g. by visiting http://www.zotero.org/support/?do=login ).
  • Editing a page: Once you are logged in, you will be able to edit pages, and view recent changes through a toolbar at the bottom of each support page. To edit the page, simply click the edit page button that appears at the bottom of a page or section. You can read up on the syntax for Zotero's wiki here: http://www.zotero.org/support/wiki/syntax
  • Creating a page: To create a new page simply type in the URL where you want your page to reside. If no page exists at that location, you will be told “This topic does not exist yet”. Click the “Create this page” button to create the page.
dev/writing_documentation.1296657999.txt.gz · Last modified: 2011/02/02 09:46 by rmzelle