OniGalore:Current events: Difference between revisions

From OniGalore
Jump to navigation Jump to search
(→‎External link review: feature has been implemented)
m (→‎Improving the documentation: adjusting headers to make them more link-friendly)
Line 47: Line 47:
[[Modding Oni]] has a number of notes on it about parts that need to be filled in.
[[Modding Oni]] has a number of notes on it about parts that need to be filled in.


===BSL tutorial(s)===
===BSL tutorials===
A project to document the built-in BSL commands is underway. This will replace the [[BSL:Functions]] and [[BSL:Variables]] pages with a more organized and natural system:
A project to document the built-in BSL commands is underway. This will replace the [[BSL:Functions]] and [[BSL:Variables]] pages with a more organized and natural system:
# A single, master list of all functions and variables at [[BSL:List of built-in commands]] ("BSL:List" is a shortcut that redirects there). No longer will we have to browse two pages at once when we're trying to find a command but don't remember if it's a variable or function. The list is sortable by name, group, kind (function or variable), and platform availability, but does not contain any other info on the commands. It's just intended as a quick reference. You can click the group name for any command to go to the grouped page that discusses it in the context of related commands.
# A single, master list of all functions and variables at [[BSL:List of built-in commands]] ("BSL:List" is a shortcut that redirects there). No longer will we have to browse two pages at once when we're trying to find a command but don't remember if it's a variable or function. The list is sortable by name, group, kind (function or variable), and platform availability, but does not contain any other info on the commands. It's just intended as a quick reference. You can click the group name for any command to go to the grouped page that discusses it in the context of related commands.
Line 59: Line 59:
:Progress report: {{#expr:{{PAGESINCAT:BSL functions}}+{{PAGESINCAT:BSL variables}}}}/504 commands, {{PAGESINCAT:Scripting tasks}}/38 groups done.
:Progress report: {{#expr:{{PAGESINCAT:BSL functions}}+{{PAGESINCAT:BSL variables}}}}/504 commands, {{PAGESINCAT:Scripting tasks}}/38 groups done.


===XML tutorial(s)===
===XML tutorials===
See the category for [[:Category:Articles_that_need_finishing|articles that need finishing]].
See the category for [[:Category:Articles_that_need_finishing|articles that need finishing]].



Revision as of 15:58, 18 June 2017

WIKI WORK IS FUN!
Penny Arcade - EvilCorp Too.png
ENOUGH FOR A JOKE OR TWO
THEN IT GETS BORING
If you're not familiar with wikis, see OniGalore:About. If you're not confident about editing a wiki, see Help:Editing.

These are only suggestions, although some are more obviously needed than others. Whatever in this list looks interesting to you, feel free to tackle it, even if you only have a little time here and there. However, if you are leaving a project half-done until you can resume it, please note that under the item in this list.

Thanks for whatever you can do to contribute.

General wiki work

External link review

Help us fight against link rot by correcting bad links that have been found by our automated script. The latest report on bad links will always be found here.

How to fix bad links

  • In most cases, fixing an NG link will mean finding the desired web page in the Internet Archive and linking to that archived page instead.
  • In some cases, an NG link will not be recoverable and should be surrounded in nowiki tags like this to remove it from the external links table, so that it stops showing up in the reports.
  • Links marked as IW are external links that could be interwiki links, which make links shorter and more resistant to rot. The suggested interwiki link markup will be given in the report. For Wikipedia, you can add a language code in order to link to a page in a specific language, e.g. [[wikipedia:de:Test]].

Background

While MediaWiki makes it easy to find bad links to pages on our own wiki, marking them in red and providing tools like Wantedpages, there is no automatic check of external links. MediaWiki compiles all these links into a table, but it does not ping the URLs to see if they give any response. The most you are allowed to do is search through the links table, and even that isn't implemented well. Over the years, many links on our wiki have gone dead as the Web has changed and various file hosts have gone out of business.

So I have implemented an automated solution that will help us catch these problems more easily; a human hand will still be needed to fix the problems. Here's how it works: every day, a script written by Alloc dumps MW's external links table to this location. I will regularly be running a script which walks through the table and looks for URLs that return NG codes like 404. It will also detect other problems in the future.

Coming features

  • Detection of "external internal" links, which occur when someone puts the full URL to another page on this same wiki, like "[http://wiki.oni2.net/OniGalore:Current_events]" instead of "[[OniGalore:Current events]]".
  • At a cursory glance, I can see that many external links no longer display the content that they were intended to display. In many cases, web sites are silently redirecting the user to their main page without using the appropriate code that indicates the content was not found. Only visual inspections of the pages can catch these issues. Once we have dealt with the low-hanging fruit of pages that return NG codes, the screenshot feature in the script will be activated, which will allow us to easily confirm if the "OK" links (and "OK" snapshots from the Internet Archive) are actually loading the intended page.

PlayStation 2 port

The community has always tended to overlook the PlayStation 2 port of the game, for fairly obvious reasons -- it doesn't play as well, and it's impractical to mod a disc-based console game. Nevertheless, we ought to have a page like PS2 Oni vs. PC Oni, modeled on Windows Oni vs. Mac Oni, which explains the differences in PS2 Oni from Win/Mac Oni. We should also devote at least a tiny amount of research to the contents of the game data. Might some unexpected resources be in there? First we need to know how to read the game data. Based on a cursory examination, resources were moved around and re-packed, but one would expect that the basic binary format of the tags has not changed. Thus, it would be nice to have a page like OBD:PS2 that gives at least a high-level view of the binary data (e.g., how the .dat files are now packed).

Improving the documentation

Modding introduction

Modding Oni has a number of notes on it about parts that need to be filled in.

BSL tutorials

A project to document the built-in BSL commands is underway. This will replace the BSL:Functions and BSL:Variables pages with a more organized and natural system:

  1. A single, master list of all functions and variables at BSL:List of built-in commands ("BSL:List" is a shortcut that redirects there). No longer will we have to browse two pages at once when we're trying to find a command but don't remember if it's a variable or function. The list is sortable by name, group, kind (function or variable), and platform availability, but does not contain any other info on the commands. It's just intended as a quick reference. You can click the group name for any command to go to the grouped page that discusses it in the context of related commands.
  2. Grouped pages which discuss all the functions/variables related to a certain task. This is where the detailed coverage of commands will be found. See BSL:AI activity for an example.
  3. Each command will also have its own page, so typing in the name of that command, e.g. "ai2_active", in the Go/Search box will take you to a page that allows you to either edit the basic information about that command or to visit its group's page.

The master list, the grouped pages, and the individual command pages are all dynamically interlinked (the system is explained here). When I am done porting all commands to the new templates and creating all the grouped pages, BSL:List will automatically be completed, and the BSL:Functions and BSL:Variables pages will be replaced by messages that direct the reader to BSL:List and to the instructions for using functions/variables on BSL:Manual.

I regret that the complex nature of the documentation system probably makes it feel difficult to contribute to, but it actually isn't as complicated as it seems, so if you would like to contribute, just let me know about any questions you have. --Iritscen (talk) 23:59, 11 May 2017 (CEST)

Progress report: 40/504 commands, 7/38 groups done.

XML tutorials

See the category for articles that need finishing.

Oni 2 and beyond...

Some fans use the wiki to write sequels, prequels, interquels (what may have happened to Konoko in the time gaps between the original chapters, e.g., between Chapter 12 and Chapter 13) or even paraquels (e.g., what was happening on the Syndicate side during Oni?). You can then list your work HERE. Just be aware of the rights issues attendant with posting fan fics here. Also, plagiarism is not nice, but "Oni 2" can still be influenced by anime/cyberpunk/other references. See HERE to review the influences so far, elaborate on them some more, or point out new ones.