Adding a New Utility Page to My Site

Likaa · December 10, 2018, 10:57am

Hello,

I am trying to add an Article Archive page to my website.
There is an existing Issue Archive page and I’m studying its file (issueArchive.tpl), but I cannot decrypt how the URL pathing works:
<a href="{url router=$smarty.const.ROUTE_PAGE page="issue" op="archive"}">

I suspect that "issue" and "archive" are just key names but even then, where do I find this list of definitions to edit?

Any help would be appreciated.

ctgraham · December 13, 2018, 1:48pm

Page URLs in OJS take the form of: /index.php/context/page/op/ . For example, if OJS is installed at http://myhost.tld/ with restful URLs to hide the index.php, and if you have a journal with a path / shortname of “myJournal”, the “archive” operation for the “issue” page is:
http://myhost.tld/myJournal/issue/archive

This is processed by:

github.com

pkp/ojs/blob/main/pages/issue/IssueHandler.inc.php#L114-L155


    if (($galley = $this->getGalley()) && $this->userCanViewGalley($request)) {
        if (!HookRegistry::call('IssueHandler::view::galley', [&$request, &$issue, &$galley])) {
            $request->redirect(null, null, 'download', [$issue->getBestIssueId($journal), $galley->getBestGalleyId($journal)]);
        }
    } else {
        self::_setupIssueTemplate($request, $issue, $request->getUserVar('showToc') ? true : false);
        $templateMgr->assign('issueId', $issue->getBestIssueId());

        // consider public identifiers
        $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true);
        $templateMgr->assign('pubIdPlugins', $pubIdPlugins);
        $templateMgr->display('frontend/pages/issue.tpl');
    }
}

/**
 * Display the issue archive listings
 *
 * @param $args array
 * @param $request PKPRequest

This file has been truncated. show original

courtesy of:

github.com

pkp/ojs/blob/main/pages/issue/index.php#L18-L27


switch ($op) {
    case 'index':
    case 'current':
    case 'archive':
    case 'view':
    case 'download':
        define('HANDLER_CLASS', 'IssueHandler');
        import('pages.issue.IssueHandler');
        break;
}

If you want to add a new operation to an existing handler, it would be a modification of one of the handler classes in /pages/. If you want to add a new dynamic page handler, it would be a new directory, index.php, and handler class under /pages/. If you just want a static page, see the “Static Pages” generic plugin.