Shiroizu
commented
1 month ago 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:
- Song/Edit CSS(.edit-text)
- https://wiki.vocadb.net/docs/songs/song-entry-editing#song-description
More realistic example with the Romanized title -field:
- Song/Edit CSS("tr:nth-child(2) input") [unstable css selector]
- https://wiki.vocadb.net/docs/other-guidelines/entry-names-and-aliases#romanized
- https://wiki.vocadb.net/docs/songs/song-entry-editing#names [includes all the song name rules, not just romanized]
- https://wiki.vocadb.net/docs/other-guidelines/romanization-guidelines [full page 1, too large for the infobox]
- https://wiki.vocadb.net/docs/other-guidelines/romanization-walkthrough [full page 2]
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
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.
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