diff --git a/README.md b/README.md index b2fd147..b9ef02e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,20 @@ Lets moderators claim a topic to tell the other moderators they are looking afte - Claims go away with their topic or their moderator when either is deleted. - Screen-reader text and labels on the claim marks, notice, list and forms. +The [wiki](https://github.com/phpbbmodders/topicclaim/wiki) has the full documentation: claiming topics, settings and permissions, and troubleshooting. + +## Screenshots + + + + + + + +
Claimed topics in a forum's topic listClaim page with take over, transfer and releaseMCP Claimed topics list
+ +Click an image for the full size. See the [screenshot gallery](docs/images/screenshots/README.md) for the rest. + ## Permissions | Permission | Where | Default | diff --git a/docs/images/screenshots/README.md b/docs/images/screenshots/README.md new file mode 100644 index 0000000..fc23b38 --- /dev/null +++ b/docs/images/screenshots/README.md @@ -0,0 +1,33 @@ +# Topic Claim screenshots + +Taken on phpBB 3.3 with prosilver, using `phpbb-test-board/screenshots.py` from [phpbb-release-tools](https://github.com/phpbbmodders/phpbb-release-tools), on a board filled with seed-forum's standard fixtures, with the default settings. The moderator `forum_moderator` has claimed one topic with a note, and the admin has claimed another. Claims show only to moderators, so every screenshot is taken as the admin. Click an image for the full size. + +## Forum topic list + +Claimed topics show the claim icon (`fa-eye`) and who holds the claim, or "Claimed by you" for your own claims. Hover over the mark to see when the topic was claimed and its note. + +Claimed topics in a forum's topic list + +## Topic page + +A notice below the topic title shows who claimed the topic, when, and the note, with a link to manage the claim. + +Claim notice below the topic title + +## Claim page + +Opened from the topic's **Quick-mod tools** or the claim marks. An administrator can take over another moderator's claim, transfer it to another moderator of the forum, or release it. + +Claim page with take over, transfer and release + +## MCP → Claimed topics + +Every claim in the forums you can claim in, or only your own, with a link to manage each one. + +MCP Claimed topics list + +## ACP settings + +**Extensions → Topic Claim → Settings**: release claims when their topic is locked, release claims after a number of days, and choose the claim icon. + +ACP settings diff --git a/docs/images/screenshots/topicclaim-acp-settings.png b/docs/images/screenshots/topicclaim-acp-settings.png new file mode 100644 index 0000000..5a78486 Binary files /dev/null and b/docs/images/screenshots/topicclaim-acp-settings.png differ diff --git a/docs/images/screenshots/topicclaim-manage.png b/docs/images/screenshots/topicclaim-manage.png new file mode 100644 index 0000000..f609d9b Binary files /dev/null and b/docs/images/screenshots/topicclaim-manage.png differ diff --git a/docs/images/screenshots/topicclaim-mcp.png b/docs/images/screenshots/topicclaim-mcp.png new file mode 100644 index 0000000..43e0827 Binary files /dev/null and b/docs/images/screenshots/topicclaim-mcp.png differ diff --git a/docs/images/screenshots/topicclaim-viewforum.png b/docs/images/screenshots/topicclaim-viewforum.png new file mode 100644 index 0000000..9b55f0d Binary files /dev/null and b/docs/images/screenshots/topicclaim-viewforum.png differ diff --git a/docs/images/screenshots/topicclaim-viewtopic.png b/docs/images/screenshots/topicclaim-viewtopic.png new file mode 100644 index 0000000..f0cdd84 Binary files /dev/null and b/docs/images/screenshots/topicclaim-viewtopic.png differ