Page MenuHomePhabricator

Improve on-wiki documentation for Cite features
Closed, ResolvedPublic5 Estimated Story Points

Description

Documentation for book referencing should be added to existing docs about Cite references. These could use some love.

Do this before or alongside documenting book referencing itself, ideally.

What to do:

  • Add sub-headings for features like footnote groups. These might still be embedded under the "<ref>" tag section for example, or split out into a full section talking about the concept, usage, giving examples, etc.
  • As in above point, maybe reorganize according to concepts rather than along technical lines.

Where to work:

Documents out of scope for now:

Event Timeline

Because of Page Translation, we're considering deleting the Help:Cite page, and moving Extension:Cite -> Help:Cite, because it has the best user-centric content.

awight set the point value for this task to 8.

For the developer portion of this work, we plan to rewrite the Extension:Cite page to show the basic functionality as a person might learn from reading the code, but not as user stories.

JStrodt_WMDE subscribed.

My part will be to move the Usage and the Customization section from Extension:Cite to Help:Cite, and to describe on Help:Cite what the extends attribute does. Postponed until 2.12. Until then, I'm un-assigning the task so developers can pick it up to work on Extension:Cite.

My part will be to move the Usage and the Customization section from Extension:Cite to Help:Cite, and to describe on Help:Cite what the extends attribute does. Postponed until 2.12. Until then, I'm un-assigning the task so developers can pick it up to work on Extension:Cite.

This part is now done. @Devs, you can take over and adjust https://www.mediawiki.org/wiki/Extension:Cite as you see fit.

WMDE-Fisch changed the point value for this task from 8 to 5.Dec 11 2019, 12:10 PM

I ran out of steam on this iteration, here's a summary of what has changed:

  • All usage instructions moved from Extension:Cite to Help:Cite.
  • Configuration variables documented.
  • Extension template metadata updated.
  • Clean up formatting, translate tags, and details.
  • Deprioritize "follow" feature by moving lower in the doc.
  • Remove error message documentation.
WMDE-Fisch moved this task from Demo to Done on the WMDE-QWERTY-Sprint-2019-12-11 board.
WMDE-Fisch subscribed.

Looks good, thanks for the work. I consider this done.