Skip to content

docs(archivist): Replace guessed ArchivistGrouper property docs - #605

Open
Ibochkarev wants to merge 2 commits into
modxorg:3.xfrom
Ibochkarev:docs/issue-47-archivistgrouper
Open

docs(archivist): Replace guessed ArchivistGrouper property docs#605
Ibochkarev wants to merge 2 commits into
modxorg:3.xfrom
Ibochkarev:docs/issue-47-archivistgrouper

Conversation

@Ibochkarev

Copy link
Copy Markdown
Collaborator

Description

Rewrites the ArchivistGrouper page so property descriptions and defaults come from the Archivist Extra source (snippet.archivistgrouper.php, build properties, lexicon, and default chunks) instead of the old “guessed” table.

Also notes ArchivistGrouper in the Archivist overview (three snippets, not two).

RU/ES have no Archivist docs tree, so this change is EN only.

Archivist is an Extra (modxcms/Archivist); it is not shipped in Revolution core, so there was nothing to sync from Revolution 3.x.

Notable corrections vs the old page: itemTpl default itemBrief, parents/target fall back to the current Resource, dateFormat is PHP strftime (not MySQL DATE_FORMAT), limitItems 0 means unlimited, toPlaceholder/locale/where documented, and the broken groupTpl table row fixed.

Affected versions

Docs for the Archivist Extra (used with MODX 2.x and 3.x). Content targets the current Docs 3.x tree.

Relevant issues

Fixes #47

Rewrite the page from snippet.archivistgrouper.php and the Extra
lexicon so defaults, chunks, and filter URL behavior match the package.

Fixes modxorg#47
@Ibochkarev
Ibochkarev marked this pull request as ready for review August 16, 2026 12:02
@Ibochkarev
Ibochkarev requested a review from Mark-H August 16, 2026 12:02
The descriptions in the table are just a guess!!! Someone with more experience or the creator should confirm or adjust these!!
Articles ships Archivist and uses this snippet for nested archive navigation. You can call it on any site that has the Archivist package installed.

Verified against [modxcms/Archivist](https://github.com/modxcms/Archivist) (`snippet.archivistgrouper.php` on `develop`). Archivist is an Extra, not part of MODX Revolution core.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird thing to include

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed — agreed, that meta note did not belong on the page.

Remove the meta “verified against” note called out in review on modxorg#605.
@Ibochkarev
Ibochkarev requested a review from Mark-H August 17, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ArchivistGrouper documentation very insecure

2 participants