Module: Seeries
Development and Programming
The attached add-on files may be out of date. Please visit Devot-ee for the latest versions.
“Seeries” means “entry series”.
This module/extension is inspired by Andrew Weaver’s Selected Items module. It has the same purpose - to allow multiple custom ordering of entries.
Except the purpose and general concept everything else is different:
1) Seeries module has completely different interface; it supports pagination in all relevant places of the module’s interface;
2) it allows to assign to members the right to edit particular entry series (further “seeries”); members can see only those seeries they are permitted to;
3) it allows do define seeries more flexibly;
4) it has option allowing seeries to be updated automatically;
5) it uses more efficient ‘weblog_entries_query_result’ hook.
INSTALLATION
1) copy “seeries” directory into “modules” directory on the server;
2) copy “ext.seeries_ext.php” file into “extensions” directory on the server;
3) copy “lang.seeries.php” file into “language/english” directory on the server;
4) go CP Home > Admin > Utilities > Extensions Manager and enable “Seeries” extension;
5) go CP Home > Modules find “Seeries” module in the list and click “Install”; the module will be installed;
6) then open the page of “Seeries” module and click button “Define or Edit Seeries”; Define some seeries.
7) Then again open the page of “Seeries” module and assign just defined seeries to some member or to some member group; now that member or all members of that member group has the right to custom order entries belonging to seeries. Notice: Seeries assignments made on member level override those made on member group level; but you can revoke member-level assignments for entire group while assigning Seeries to it. Also you can revoke member-level assignments for single member. In relevant places letter “m” marks that the assignment of seeries was made on member level, while letter “g” marks that assignment was made on group level.
CUSTOM ORDERING OF ENTRIES
Logged-in member after opening the page of “Seeries” module sees all seeries he has the right to reorder. To reorder some seeries he must click the link displaying seeries name. Then a list of entries belonging to seeries will be displayed.
To reorder seeries checkboxes should be checked and new count numbers should be entered in relevant text fields. To exclude entry from seeries text field should be left blank. Entries excluded from seeries are displayed at the bottom of the list.
DISPLAYING CUSTOM ORDERED ENTRIES
To display entries in the order specified by seeries one should use {exp:seeries} tag. This tag has following parameters:
1) “id”, “id_1”, “id_2”, “id_3” … “id_48”, “id_49”, “id_50” - allows to specify one or more seeries id numbers.
2) “name”, “name_1”, “name_2”, “name_3” … “name_48”, “name_49”, “name_50” - allows to specify one or more seeries names.
At least one out of “id”, “id_1”, “id_2”, “id_3” etc. or “name”, “name_1”, “name_2”, “name_3” etc. parameters of exp:seeries tag must be defined, since ids and names are used to uniquely identify seeries.
{exp:seeries} tag has following variables:
1) {seeries} - outputs content of the seeries specified by “id” or “name” parameter.
2) {seeries_1}, {seeries_2}, {seeries_3} … {seeries_48}, {seeries_49}, {seeries_50} outputs content of the seeries specified by “id_1”, “id_2” … “id_49, “id_50”, or “name”, “name_1”, “name_2”, “name_3” … “name_48”, “name_49”, “name_50” parameters.
{exp:seeries} tag can be used to wrap {exp:weblog:entries} tag; {exp:weblog:entries} tag must have “orderby” parameter value set to “seeries”:
{exp:seeries name="eee" parse="inward"}
{exp:weblog:entries entry_id="{seeries}" orderby="seeries"}
<a href="http://{homepage}/template_group/template/{url_title}/">{title}</a>
{/exp:weblog:entries}
{/exp:seeries}Also {exp:seeries} tag can be used to wrap {exp:entries_list} tag of Entries List plugin:
{exp:seeries name="aaa" parse="inward"}
{exp:entries_list entry_series="{seeries}" site="1" }
<a href="http://{weblog_url}/{url_title}/class=menuItem">{title}</a>
{/exp:entries_list}
{/exp:seeries}NEW PARAMETERS OF exp:weblog:entries TAG
1) seeries_limit - if you wrap with exp:seeries tag the tag exp:weblog:entries, then its “limit” parameter will work correctly only in case “paginate” parameter and {paginate}{/paginate} variable pair is used. In cases you do not use “paginate” parameter and {paginate}{/paginate} variable pair use instead of “limit” parameter use “seeries_limit” parameter.
2) seeries_entry_id_from - if you wrap with exp:seeries tag the tag exp:weblog:entries, then its “entry_id_from” parameter will not work correctly. Use instead “seeries_entry_id_from” parameter.
3) seeries_entry_id_to - if you wrap with exp:seeries tag the tag exp:weblog:entries, then its “entry_id_to” parameter will not work correctly. Use instead “seeries_entry_id_to” parameter.
I just did a quick test. Looks extremely handy and thank you again for another brilliant add-on! 😊
After using it for a little while I had a couple of observations…
The reordering method is a little strange in that it doesn’t seem to follow other EE UI methods of reordering. The more common methods are drag-and-drop (like Structure and FF Matrix) or clicking to order all entries by number or arrows – as opposed to your method of checking the box in an (currently unlabeled) column and then clicking submit to reveal the field to type in the new position number. Especially since you use up/down arrows on the main page for ordering.
I think it would probably be useful to be able to assign permission to all members of a Member Group in some cases.
I appreciate your sharing your work with the community.
I echo Smartpill, and I have needed something like this for a long time, seeriously. Your work fills an unusual, yet vital, niche in the EE ecology. Will test and report if I observe anomalies.
I’d like to check this out, but I’m getting some sort of error - I get a white screen when I try to define a new seeries. 1.6.8 build 20091002. Of course I’m running a heap of extensions - wonder if there’s a conflict of some sort?
Hi all,
The more common methods are drag-and-drop (like Structure and FF Matrix) or clicking to order all entries by number or arrows—as opposed to your method of checking the box in an (currently unlabeled) column and then clicking submit to reveal the field to type in the new position number. Especially since you use up/down arrows on the main page for ordering.
I used up/down arrows for ordering list of available seeries and list of assigned seeries because I assumed that these lists hardly ever will be very long; and I avoided using up/down arrows for ordering of entries since lists of entries can be very long - consisting of hundreds and even thousands of entries. Reordering of such long lists neither drag-drop nor arrows are handy; only manual entering of count numbers is.
I think it would probably be useful to be able to assign permission to all members of a Member Group in some cases.
I will think about such enhancement when releasing new version.
I get a white screen when I try to define a new seeries. 1.6.8 build 20091002.
My build is a couple of months older, but I doubt that the issue has anything to do with builds. More probably it is caused by some conflict between extensions. Could you try to disable other extensions and check if the issue persists?
Hi all,I get a white screen when I try to define a new seeries. 1.6.8 build 20091002.My build is a couple of months older, but I doubt that the issue has anything to do with builds. More probably it is caused by some conflict between extensions. Could you try to disable other extensions and check if the issue persists?
I’m in the midst of a huge push right now; when I get a free moment - say, over the weekend - I’ll try that. I wish there where some easier way to disable extensions for testing - some sort of checkboxes or something. And settings always seem to end up garbled….
Can’t wait to play around with this, though. Thx!
This works as described for me on build 1.6.8 20090915 with lots of extensions installed.
The more common methods are drag-and-drop (like Structure and FF Matrix) or clicking to order all entries by number or arrows—as opposed to your method of checking the box in an (currently unlabeled) column and then clicking submit to reveal the field to type in the new position number. Especially since you use up/down arrows on the main page for ordering.I used up/down arrows for ordering list of available seeries and list of assigned seeries because I assumed that these lists hardly ever will be very long; and I avoided using up/down arrows for ordering of entries since lists of entries can be very long - consisting of hundreds and even thousands of entries. Reordering of such long lists neither drag-drop nor arrows are handy; only manual entering of count numbers is.
That’s a good point. I do like how the row becomes editable when the button is checked. I just think it could be clearer to the user. I’ve attached a screenshot of 3 suggestions I believe would help:
- Add “edit” to the table header above the checkboxes
- Change “submit” to “update order”
- Add the option to customize instructions above the table, or add simple instructions for the user such as “Check the boxes on the left to edit the order and click ‘update order’ button to apply.” I’m not sure what the “description” field is for. Maybe that can be used for text above each “seeries”?
I also wanted to let you know that the ability to restrict the lists to specific weblogs, categories and statuses is amazingly helpful.
As the designer/developer for 4 independent hyperlocal news sites in CT/MA area, I want to wish Dylan Smith/ContextDesign good luck with the launch of tucsonsentinel.com.
Hi all,
Thanks for excellent suggestions.
I released version 1.1 of Seeries module.
New in this release:
1) added possibility to assign group-level permissions to edit seeries; member-level permissions override group-level permissions;
2) added “Edit” to the table header above the checkboxes in seeries order page;
3) changed “Submit” to “Update Order” in seeries order page;
4) added brief instructions for the user in seeries order page.
Please report any bugs you encounter.
Hi all,
Just released version 1.2.1 of Seeries module. In this version a serious issue was solved - permissions assigned at group level only possible to change at member level.
Now Seeries assignments made on group level can be changed both on group level and at member level. Since Seeries assignments made on member level override those made on member group level, once assignment is made on member level it cannot be changed on group level.
E.g. there are seeries “aaa”, “bbb” and “ccc”. Seeries “aaa”, “bbb” and “ccc” are assigned to all members of “contributors” member group. Peter is member of “contributors” member group, but Seeries “aaa”, “bbb” and “ccc” are assigned to him directly, not through group. Now let’s say permisions to edit Seeries “aaa”, “bbb” and “ccc” are canceled for all members of “contributors” member group. Now member of the contributors” member group cannot edit seeries “aaa”, “bbb” and “ccc” anymore, except Peter. Peter retains his permissions because they are set not at the group level, but at the member level. Canceling Peter’s right to edit seeries must be done not at group level, but at member level.
I get a white screen when I try to define a new seeries. 1.6.8 build 20091002.My build is a couple of months older, but I doubt that the issue has anything to do with builds. More probably it is caused by some conflict between extensions. Could you try to disable other extensions and check if the issue persists?
Finally had a chance to take another crack at this. Same result. Downloaded the new release, disabled every other extension, and I’m getting a white page. This has got me perplexed….
Downloaded the new release, disabled every other extension, and I’m getting a white page. This has got me perplexed….
Very strange. I have no idea what might be causing such behavior. On my installation “Define or Edit Seeries” page works correctly.
For what it’s worth, I’ve installed it on 2 sites so far with no issues.
Downloaded the new release, disabled every other extension, and I’m getting a white page. This has got me perplexed….Very strange. I have no idea what might be causing such behavior. On my installation “Define or Edit Seeries” page works correctly.
Trying again: disabled all extensions, reinstalled module & extension, this page still fails to save (http://www.mysite.com/system/index.php?S=0&C=modules&M=Seeries&P=seeries_prefs). I can enter info into the form, but when I save, here’s Mr. White Page again.
Very strange indeed.
Hi,
I released version 1.4 of Seeries module.
In this release:
1) fixed bug - group level assignments not being transferred to newly created members;
2) added possibility to revoke member-level assignments for entire group.