MediaWiki Templates

[oldenbourglaura]

Here is a list of proposed templates for the MediaWiki setup.

Overview

Level on which template is used	Template category	Template
1 Corpus, 2 Report, maybe 3 Chapter	Navigation	A1 Template:ReportSwitcher
2 Report	Navigation	A2 Template:ReportTOC
3 Chapter	Navigation	A3 Template:ChapterNav
2 Report	Information	B1 Template:ReportInfobox
3 Chapter	Information	B2 Template:ChapterInfobox
2 Report	Information	B3a Template:ReportCitation
3 Chapter	Information	B3b Template:ChapterCitation
2 Report	Information	B4a Template:ReportContributors
3 Chapter	Information	B4b Template:ChapterContributors
2 Report	Information	B5a Template:ReportBibliodata
3 Chapter	Information	B5b Template:ChapterBibliodata

A) Navigation Templates

These are templates used for providing navigation possibilities to the user. Please feedback.

Proposed templates:

• A1) Template:ReportSwitcher, a compact widget showing all 7 reports, highlighting the current one:
  • Cover (linked)
  • Short title of reports
• A2) Template:ReportTOC, displaying a list of chapters in a report, with:
  • Chapter titles (linked)
  • Chapter estimated reading time (tbd)
• A3) Template:ChapterNav, displaying:
  • Link to previous chapter (with title?)
  • Link to next chapter (with title?)
  • Link back up to report (with title?)

Other navigation possibilities for the user, not handled by templates

• Chapter content TOC is handled by the automated book navigation in the sidebar
• Additional Report content TOC is handled by the automated book navigation in the sidebar
• Automated Breadcrumbs show position within: Project > Corpus > Report > Chapter

Reading progress, tba

There could be possible tempates indicating reading progress for the user, like

• Template:ChapterProgress: Where am I in this report?
• Template:CorpusBreadcrumb: Where am I in the corpus?

B) Information Templates

These are templates used for providing information about the "object" that the user is currently looking at. Please feedback.

Proposed templates:

• B1) Template:ReportInfobox, displaying:

  • Report cover thumb
  • Report title
  • Scope (for example Word count, Chapter count)
  • Key topics
  • Relation to other reports (tbd)

• B2) Template:ChapterInfobox, displaying:

  • Chapter title
  • Chapter is from which report
  • Estimated reading time (tbd)
  • Key topics
  • Confidence levels present (tbd)
  • Chapter summary

• B3a) Template:ReportCitation, displaying:

  • Citation suggestion for report

• B3b) Template:ChapterCitation, displaying:

  • Citation suggestion for chapter

• B4a) Template:ReportContributors, displaying (grouped by role):

  • Author name
  • Author role
  • Origin (tba)

• B4b) Template:ChapterContributors, displaying (grouped by role):

  • Author name
  • Author role
  • Origin (tba)

• B5a) Template:ReportBibliodata, displaying:

  • Bibdata suggestion for report

• B5b) Template:ChapterBibliodata, displaying:

  • Bibdata suggestion for chapter

C) Statistics Templates, tbd

These need planning. These templates provide additional data, which is not necessarily required for navigation or understanding the corpus. Feedback not needed at this point.

Proposed templates:

• Template:CorpusQuantification
• Template:CorpusScope (pulling for example all Topic and Region values across the corpus)
• Template:ProjectProgress
• Template: Template(s) for visualisation of certain aspects, tbd
• Template: Template(s) for showing things like timelines etc., tbd

D) Design Templates, tbd

These templates will be used to create a consistent and reusable library of design elements. This list will be planned one the design is laid out. Feedback not needed at this point.

Proposed templates:

Buttons

• Template:BtnNeutral
• Template:BtnPrimary
• Template:BtnSecondary

People

• Template:AuthorPill

More

• many more, tba

[mrchristian]

Looks good:

Re: Nav

• We already have the in page Chapter Header ToC, which can be presented collapsed or open on start.
• Im not sure if we need Reading Time as I think the reading type here is to dip into something.
• The Orientation feature is good, like where am I - think Hansel and Gretel's (breadcrumbs) or the Labyrinth and Ariadne’s (thread)

Infoboxes

B 4a, 4b - this might be able to come from the use of MediaWiki Categories when Contributors are categorised, but the same data will be mirrored in Wikibase so can come from their too.