To-Do¶
Todo
Add instructions for updating ignored users in the reset-wiki script and for first saving exemplars.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-last-year.rst, line 81.)
Todo
Need to add instructions for updating miscellaneous wiki pages, syllabus dates, assignment dates, survey session dates after resetting the wiki.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-last-year.rst, line 129.)
Todo
Make the backup script that lives on DynamicsHJC and the cron job list downloadable.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/config-backups.rst, line 38.)
Todo
The “Files to Import” directory is now hosted online. Add instructions for modifying it.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/copy-contents.rst, line 217.)
Todo
Update this step with instructions for adding files to the online
“BIOL-373-Files-to-Import.tar.bz2” archive, and move the
fetch_wiki_files.sh script to an external file in the docs source.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/copy-contents.rst, line 236.)
Todo
For exporting content from the 2015 wiki, the commands above are fine,
but they should be revised for the future by removing the public_
prefix and using the wikidb database name.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/create-assignments.rst, line 34.)
Todo
Add a similar message about prefixing uploaded file names with a student’s user name to VisualEditor.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/customize-wiki.rst, line 72.)
Todo
Consider what should be done about the User namespace template if I can’t get VisualEditor to work with NewArticleTemplate.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/customize-wiki.rst, line 233.)
Todo
Walkthrough deleting all but the most recent snapshot to save disk space.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/delete-snapshots.rst, line 4.)
Todo
Get Wikipedia’s advanced citation tools for VisualEditor, especially automatic citation completion from URLs, DOIs, and PMIDs.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-citation-tools.rst, line 4.)
Todo
Add screenshots showing the various citation tools in action.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-citation-tools.rst, line 9.)
Todo
Add tests for VisualEditor’s citation tools.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-citation-tools.rst, line 144.)
Todo
Change parsoid install command to use a specific version known to work with MW 1.27 (version “0.5.3all” ?).
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 46.)
Todo
Consider adding Mathoid installation instructions. In its current form,
this instruction set utilizes the Math extension’s PNG mode. By changing
$wgDefaultUserOptions['math'] to 'mathml' in
LocalSettings.php, an alternate MathML mode can be used. This
requires a Mathoid server for runtime equation rendering. The
$wgMathFullRestbaseURL setting specifies a server in Germany that is
free to use but is occasionally unresponsive, causing the wiki to either
load slowly or fail to render equations. By building a local Mathoid
server, responsiveness and reliability could be guarenteed. However,
after much effort, Jeff has not been able to get a Mathoid installation
working yet. Since MathML offers few advantages over PNG mode, getting
this working is a low priority.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 142.)
Todo
Update the patch for MobileFrontend. For now, skip this step during installation.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 194.)
Todo
Explain the function of NewArticleTemplate better here and in terms of the subpages actually used by students.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 217.)
Todo
Add hooks to NewArticleTemplate so that it works with VisualEditor.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 251.)
Todo
Fork NewArticleTemplate on GitHub and incorporate the “always use subpage template” patch and the hooks for VisualEditor.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 255.)
Todo
Fork Realnames on GitHub and incorporate the “ignore subpage titles” patch.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 279.)
Todo
Post my solution for the VisualEditor + Lockdown extension conflict to the discussion board, and then provide a “This solution is documented here” footnote in these instructions.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 328.)
Todo
Embedded videos don’t render in VisualEditor. Fix?
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 415.)
Todo
When attempting to upload files through VisualEditor, it thinks I’m not logged in. Fix!
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-extensions.rst, line 419.)
Todo
Add screenshots showing what the message box test result should look like.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/build-from-scratch/install-mbox.rst, line 72.)
Todo
Provide instructions for changing the wiki logo or favicon, including skin adjustments to accomodate logo size.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/change-logo-favicon.rst, line 4.)
Todo
Make the backup script that lives on DynamicsHJC and the cron job list downloadable.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/config-dev-server.rst, line 51.)
Todo
Provide form emails for instructors (e.g., absences, tardies).
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/form-emails.rst, line 4.)
Todo
Write an intro to Git.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/git-intro.rst, line 4.)
Todo
Add instructions for giving students privileges to access the private areas of the wiki and for getting a term paper deadline extension.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/grant-student-privileges.rst, line 4.)
Todo
Verify that Student Device Registration works for non-students.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/mac-addresses.rst, line 59.)
Todo
The instructions for new TAs ought to be moved to their own page.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/maintenance-cheatsheet.rst, line 4.)
Todo
Install phpMyAdmin for a web interface for changing real names.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/modify-real-names.rst, line 9.)
Todo
Add instructions for changing real names in Django.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/modify-real-names.rst, line 36.)
Todo
Add general instructions for compiling the docs. Note that these can also be found in the README.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/update-docs.rst, line 19.)
Todo
Document method of creating a pre-configured LocalSettings.php file,
which is just a modified version of the file created by default by the
script maintenance/install.php.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/neurowiki-docs/checkouts/latest/source/update-docs.rst, line 30.)