Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow easier, direct access to wiki articles #134

Open
riipah opened this issue Mar 14, 2016 · 1 comment
Open

Allow easier, direct access to wiki articles #134

riipah opened this issue Mar 14, 2016 · 1 comment
Labels
backlog/on hold Uncompleted issues that will be worked on after completing other specific issues/tasks first complexity: unknown Unknown days of work content: Wiki VocaDB Wiki feature request feedback-wanted Feedback and further discussed needed (open questions) frontend Presentation layer (visible to user) guidance User instructions/guidelines priority: low Issues/Tasks that are not so important UX/usability UX (User Experience): Methods for improving the usablitiy weblink Domain object: URL, weblink, hyperlink

Comments

@riipah
Copy link
Member

riipah commented Mar 14, 2016

We should make it easier to access the wiki articles right where they are needed on site. For example, link to the article about artist roles in the roles edit dialog.

The current help page is difficult to manage. It's written in ASP.NET Razor markup and requires programming.

Method

The most simple way would be just to provide links to wiki articles, opening in a new browser window. Links could be provided under title "Related wiki articles". Better usability could be achieved by retrieving the wiki content server-side and embedding it on the site, or in a JavaScript popup. Parsing the HTML, taking just the content, should be easy.

Linking to articles

The URLs to articles cannot be hardcoded because they can change. We need some kind of mapping. A configuration file similar to nico tag mapping might be enough.

Translations?

Help page is currently translated in multiple languages. The wiki system does not support translations. How to handle this?

Related: #241

@riipah riipah added the UX/usability UX (User Experience): Methods for improving the usablitiy label Mar 14, 2016
@riipah riipah added the guidance User instructions/guidelines label Jul 9, 2017
@ycanardeau ycanardeau added this to the Backlog milestone Nov 19, 2020
@ycanardeau ycanardeau added the frontend Presentation layer (visible to user) label Apr 10, 2021
@andreoda andreoda added content: Wiki VocaDB Wiki weblink Domain object: URL, weblink, hyperlink backlog/on hold Uncompleted issues that will be worked on after completing other specific issues/tasks first labels Apr 21, 2023
@andreoda andreoda removed this from the Backlog milestone Apr 26, 2023
@andreoda andreoda added the complexity: unknown Unknown days of work label Mar 6, 2024
@andreoda andreoda added the priority: low Issues/Tasks that are not so important label Mar 23, 2024
@Shiroizu
Copy link
Member

Approach 1: Field-rule mapping

A mapping between edit page fields and rules on the wiki requires two things:

  • A mechanism to refer to specific edit page fields. (exists for some fields through CSS Selectors)
  • A mechanism to refer to specific wiki article paragraphs. (exists for some rules)

Rare mapping example that currently works well - Song descriptions:

More realistic example with the Romanized title -field:

Field-specific referring issues can be fixed by including unique CSS ids.
Rule-specific referring issues can be solved by re-organizing the wiki pages.

Approach 2: Separate rule-page with hardcoded links

image

Alternative to the field-rule mapping is creating a separate wiki page for hosting condensed versions of all the field-related rules. These are referred with hardcoded links on edit interfaces. For example the song description -field would include a link to https://wiki.vocadb.net/docs/field-rules#song-types, which it would fetch and display when the tooltip is hovered.

Some additional details:

  • Field rules can be self-containing: Always prefer adding the desktop version of the link. -rule is true regardless of other field values.
  • Field rules can be dependant on other fields: Songs with no vocalists need the “instrumental” tag, unless the song type is “Instrumental” or “Drama PV”.

Translations

Wiki should include i18n integration instead of having separate translated page versions on the sidebar: https://docs.astro.build/en/recipes/i18n/. It might make sense to host the wiki translation efforts on CrowdIn as well. The main challenge with wiki translations has been the unstable nature of the wiki pages, as the wiki content has evolved a lot the past year.

@andreoda andreoda added the feedback-wanted Feedback and further discussed needed (open questions) label Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog/on hold Uncompleted issues that will be worked on after completing other specific issues/tasks first complexity: unknown Unknown days of work content: Wiki VocaDB Wiki feature request feedback-wanted Feedback and further discussed needed (open questions) frontend Presentation layer (visible to user) guidance User instructions/guidelines priority: low Issues/Tasks that are not so important UX/usability UX (User Experience): Methods for improving the usablitiy weblink Domain object: URL, weblink, hyperlink
Projects
Development

No branches or pull requests

4 participants