moodle/doc/index.php

<?PHP  // $Id$

    require("../config.php");

    optional_variable($file, "");     // docs file to view
    optional_variable($frame, "");    // docs file to view
    optional_variable($sub, "");      // sub-section (named anchor)
    optional_variable($lang, "");     // override current language

    if (!empty($lang)) {
        $SESSION->doclang = $lang;
        save_session("SESSION");
    }

    if (!empty($sub)) {
        $sub = "#$sub";
    } else {
        $sub = "";
    }

    if (empty($file)) {
        $include = false;
        if (empty($frame)) {
            $file = "intro.html";
        } else {
            $file = $frame;
        }
    } else {
        $include = true;
    }

    document_file($file, $include);

    if ($include) {
        exit;
    }

?>

<HEAD>
    <TITLE>Moodle Documentation</TITLE>
</HEAD>

<FRAMESET ROWS="70,*">
    <FRAME NAME="top" SRC="top.php">
    <FRAMESET COLS="200,*">
        <FRAME NAME="contents" SRC="contents.php">
        <FRAME NAME="main" SRC="index.php?file=<?PHP echo "$file$sub"; ?>">
    </FRAMESET>
</FRAMESET>
Improvements to documentation formatting, content etc 2002-10-29 14:48:58 +00:00			`<?PHP // $Id$`

			`require("../config.php");`

Framed docs can now select a named anchor in a page 2003-01-06 08:23:36 +00:00			`optional_variable($file, ""); // docs file to view`
New frame mode for dox 2003-01-01 15:13:56 +00:00			`optional_variable($frame, ""); // docs file to view`
Framed docs can now select a named anchor in a page 2003-01-06 08:23:36 +00:00			`optional_variable($sub, ""); // sub-section (named anchor)`
			`optional_variable($lang, ""); // override current language`
It's now possible to choose a documentation language on the fly! 2002-12-29 16:28:41 +00:00
			`if (!empty($lang)) {`
			`$SESSION->doclang = $lang;`
			`save_session("SESSION");`
			`}`
Improvements to documentation formatting, content etc 2002-10-29 14:48:58 +00:00
Framed docs can now select a named anchor in a page 2003-01-06 08:23:36 +00:00			`if (!empty($sub)) {`
			`$sub = "#$sub";`
Slightly more rboust 2003-01-06 08:47:57 +00:00			`} else {`
			`$sub = "";`
Framed docs can now select a named anchor in a page 2003-01-06 08:23:36 +00:00			`}`

Changes to how documentation works. A thin PHP interface now fetches files from the language packs. If a file isn't available in the current language, then English is used. 2002-12-29 14:39:52 +00:00			`if (empty($file)) {`
			`$include = false;`
New frame mode for dox 2003-01-01 15:13:56 +00:00			`if (empty($frame)) {`
			`$file = "intro.html";`
			`} else {`
			`$file = $frame;`
			`}`
Changes to how documentation works. A thin PHP interface now fetches files from the language packs. If a file isn't available in the current language, then English is used. 2002-12-29 14:39:52 +00:00			`} else {`
			`$include = true;`
			`}`

Better way to include initial intro.html 2002-12-29 14:43:49 +00:00			`document_file($file, $include);`
Improvements to documentation formatting, content etc 2002-10-29 14:48:58 +00:00
Changes to how documentation works. A thin PHP interface now fetches files from the language packs. If a file isn't available in the current language, then English is used. 2002-12-29 14:39:52 +00:00			`if ($include) {`
			`exit;`
Improvements to documentation formatting, content etc 2002-10-29 14:48:58 +00:00			`}`

			`?>`

			`<HEAD>`
			`<TITLE>Moodle Documentation</TITLE>`
			`</HEAD>`

			`<FRAMESET ROWS="70,*">`
			`<FRAME NAME="top" SRC="top.php">`
			`<FRAMESET COLS="200,*">`
			`<FRAME NAME="contents" SRC="contents.php">`
Framed docs can now select a named anchor in a page 2003-01-06 08:23:36 +00:00			`<FRAME NAME="main" SRC="index.php?file=<?PHP echo "$file$sub"; ?>">`
Improvements to documentation formatting, content etc 2002-10-29 14:48:58 +00:00			`</FRAMESET>`
			`</FRAMESET>`