Skip to content

Commit

Permalink
Remove docs from code, add links instead
Browse files Browse the repository at this point in the history
  • Loading branch information
james-cnz committed May 14, 2024
1 parent db2670d commit 91af57b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 76 deletions.
52 changes: 12 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,17 @@
# Moodle Multitopic Format
# Moodle Multitopic Format

Shows multiple topics per page, with tabbed navigation between pages.
Topics are collapsible, and can optionally be timed.
If you like the Multitopic format, and use the latest version,
please support the project by reporting any bugs you find.

> Shows multiple topics per page, with tabbed navigation between pages. Topics are collapsible, and can optionally be timed.
Developed at [Otago Polytechnic](https://www.op.ac.nz/) by James Calder.

### 🏠 [Otago Polytechnic](https://op.ac.nz)

## Links

## Install

1. Copy files to moodle/course/format/multitopic.
2. Log in as an admin, and visit moodle/admin/index.php, to update plugin data.
3. (Moodle 3.x version only) Site administration > Appearance > Additional HTML > Within HEAD (or other location appropriate for CSS): Copy and paste styles from README_styles.css (customising appropriately).
4. Site administration > Appearance > Themes > Theme settings > Allow category themes: Yes (if you want categories to have custom CSS).


## Features

* Tabbed pages (like Onetopic format)
* Multiple topics per page (a bit like Flexible Sections format)
* Collapsible topics (like Collapsed Topics format)
* Optionally timed topics (a bit like Periods format)
* Course banner image (like Snap theme)
* Section images (a bit like Grid format)


## Author

👤 **James Calder**

* Github: [@james-cnz](https://github.com/james-cnz)


## Docs

🚀 [Roadmap](docs/roadmap.md)
📄 [Contributing](docs/contributing.md)


## Acknowledgements

The Multitopic format is based on ideas from several other course formats, and notably includes code copied from:

* Onetopic format by David Herney Bernal García (including code for displaying tabs, disabling asychronous editing, and managing settings)
* Periods format by Marina Glancy (code for managing settings)
* [Home page](https://moodle.org/plugins/format_multitopic)
* [Documentation](https://github.com/james-cnz/moodle-format_multitopic/wiki)
* [Source control](https://github.com/james-cnz/moodle-format_multitopic)
* [Bug tracker](https://github.com/james-cnz/moodle-format_multitopic/issues)
* [Discussion](https://moodle.org/mod/forum/discuss.php?d=394619)
13 changes: 0 additions & 13 deletions docs/contributing.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/roadmap.md

This file was deleted.

0 comments on commit 91af57b

Please sign in to comment.