User Tools

Site Tools


help-wiki:wiki_basics

Wiki Basics

The Capstone Project, Coach, and Website Help wikis are all run on a single instance of https://dokuwiki.org

Wiki Organization

The default wiki (the one that you get when you click on the logo at the top of the wiki page) is the Capstone Project Wiki. There are no links from the Project Wiki to the Coach Wiki or the Website Help Wiki.

The Coach Wiki is available to coaches from the https://byucapstone.byu.edu Dashboard. The Coach Wiki also contains a link to the Project Wiki. If a Coach navigates from the Coach Wiki to the Project Wiki, there will be no links to take her back to the Coach Wiki. However, the bread crumb trail, the back button, and the browser history all allow the coach to return to the Coach Wiki.

The Help Wiki is available to instructors from the https://byucapstone.byu.edu Dashboard. The Help Wiki contains links to the Coach Wiki and Project Wiki. Upon navigating to the Coach Wiki or Project Wiki, instructors will need to use breadcrumbs or history to return to the Help Wiki. THere are no direct links from these wikis to the Help Wiki.

Wiki Setup

The wiki was set up by installing dokuwiki, then adding the following plugins:

  • AcMenu – prepares the sidebar menus
  • DocNavigation – Supports the navigation buttons at the top and bottom of each page
  • ImageBox – gives us images in a box format with a caption
  • nodisp – allows us to have comments that show up to the instructors, but not to the students.
  • tablewidth – allows the specification of the widths of table columns

As part of configuration, the Capstone logo was set to the wiki default logo, and a favicon from BYU was added as the favicon. These files are located in the root media directory (<dokuwiki_home_dir>/data/media).

User authorization is set up on the wiki to allow onlys specified users to edit the wiki.

The individual wikis are set up as namespaces in DokuWiki. The namespaces in use are project-wiki, coach-wiki, and help-wiki.

Search the DokuWiki documentation for more information on namespaces.

The link that is used when clicking on the logo is set according to the process on https://magoarcade.org/wp/dokuwiki-change-the-url-of-the-logo-link. The trick is to change some code in the tpl_header.php file. This is problematic because if the template is updated, it will be overwritten. That's why we want it described in the help wiki.

With the AcMenu plugin installed and the sidebar turned on, the page is too thin. The width of the page is changed by an entry in conf/tpl/docuwiki/style.ini. See https://www.dokuwiki.org/template:dokuwiki for more information.

Possible Changes

  • Implement URL rewriting to avoid the ?id= stuff that shows up in the URLs.
  • Implement authentication so that users will have the roles associated with the Drupal website.
help-wiki/wiki_basics.txt · Last modified: 2022/09/15 15:44 by cds4byu