From 9913cf29c5937f9d1b12675ca6d2bb2c38780585 Mon Sep 17 00:00:00 2001 From: William Jacoby Date: Sun, 27 Sep 2026 20:17:34 -0500 Subject: [PATCH 1/2] Rewrite the README and sync the composer description Standard phpBB Modders README layout: status badges, a short feature list, requirements, installation, contributing (org Discussions and the community forum), acknowledgments and the GPL v2.0 license section. The one-line description now matches the GitHub repo description. Co-Authored-By: Claude Opus 5.5 --- README.md | 41 ++++++++++++++++++++++++++++++++++++----- composer.json | 2 +- 2 files changed, 37 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a3f1b6b..e8b363f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ # phpBB Modders Menu -The site navigation menu used on phpbbmodders.com. +[![Tests](https://github.com/phpbbmodders/menu/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/menu/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/menu/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/menu/actions/workflows/lint.yml) -## Installation +A simple dropdown navigation menu for your board; the links are edited by hand in the template. + +## Features + +- Dropdown menu above the board's navbar, with nested sub-menus. +- Entries can be shown to one group only with `{% if S_GROUP_ %}`. Those switches come from the **Group Switches** extension (`phpbbmodders/groupswitches`); without it, group-only entries stay hidden. The shipped template uses group 528 as its example. +- Collapses behind a **Menu** button on small screens. +- No ACP settings: edit the links in `styles/all/template/event/overall_header_navbar_before.html`, then purge the board cache. -Copy the extension to `phpBB/ext/phpbbmodders/menu`. +## Requirements + +- phpBB 3.3.0 or later +- PHP 7.4 or later + +## Installation -Go to "ACP" > "Customise" > "Extensions" and enable the "phpBB Modders Menu" extension. +1. Copy the extension to `/ext/phpbbmodders/menu` +2. In the Administration Control Panel, go to **Customise → Manage extensions** +3. Enable the **phpBB Modders Menu** extension +4. Edit the links in `styles/all/template/event/overall_header_navbar_before.html` and purge the board cache ### Upgrading from `modders/menu` @@ -19,6 +34,22 @@ This extension was previously published as `modders/menu`. To switch: If you disable the old extension from the command line (`bin/phpbbcli.php`) instead of the ACP, run `bin/phpbbcli.php cache:purge` before enabling the new one; the command-line disable doesn't clear the cache. +## Contributing + +Contributions are welcome! + +- **Bug reports**: [Open an issue](https://github.com/phpbbmodders/menu/issues). +- **Everything else** (questions, feature requests, ideas, general discussion): [Use Discussions](https://github.com/orgs/phpbbmodders/discussions), or the [community forum](https://www.phpbbmodders.com/community/). +- Pull requests are welcome for bug fixes or discussed features. + +## Acknowledgments + +- Kailey Snay and bonelifer. +- Menu design and mobile fixes by Daniel James ([danieltj27](https://github.com/danieltj27)) in #1, #2 and #4. +- Code review, bug fixes, and documentation assisted by [Claude](https://www.anthropic.com/claude). + ## License -[GPLv2](license.txt) +This extension is licensed under the **GNU General Public License v2.0**. + +See [license.txt](license.txt) for more information. diff --git a/composer.json b/composer.json index af2331c..537a1ee 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "phpbbmodders/menu", "type": "phpbb-extension", - "description": "Homepage menu", + "description": "A simple dropdown navigation menu for your board; the links are edited by hand in the template.", "homepage": "https://www.phpbbmodders.com/", "version": "1.0.0-dev", "time": "2024-05-11", From 8f6e2f31e00eeb0783bc31a744f960a3a9672394 Mon Sep 17 00:00:00 2001 From: William Jacoby Date: Sun, 27 Sep 2026 20:22:53 -0500 Subject: [PATCH 2/2] README: link the wiki's editing guide and Group Switches pages Co-Authored-By: Claude Opus 5.5 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e8b363f..1a8786f 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ A simple dropdown navigation menu for your board; the links are edited by hand i 3. Enable the **phpBB Modders Menu** extension 4. Edit the links in `styles/all/template/event/overall_header_navbar_before.html` and purge the board cache +Examples for adding links, dropdowns, and entries for logged-in users or single groups are in the wiki: [Editing the menu](https://github.com/phpbbmodders/menu/wiki/Editing-the-menu) and [Group Switches](https://github.com/phpbbmodders/menu/wiki/Group-Switches). + ### Upgrading from `modders/menu` This extension was previously published as `modders/menu`. To switch: