larger smaller normal text version of this page

Formatting code for ListListsInfo


show source only

==[[PhplistDocumentation Phplist Documentation]] » [[ListAndUserFunctionsInfo List and User functions]] » ==
----
=====List Lists Documentation=====

##List## shows all the lists **owned** by an [[EditAdminsInfo admin]]. Only SuperAdmins have access to all the lists.

From this page, you can also **add and edit lists**.

===Parameters===

**{{table columns="6" cells="No ; Name ; Order ; Functions ; Active ; Owner ; 1 ; test ; 0 ; edit | view members | delete ; checkbox ;admin;; 64 Members ;;;;"}}**

##**No**##
~This is the unique ID number for the list ("1" in this example). Each list has a unique ID, regardless of its order of appearance (see ##Order## below). You cannot choose the ID number.

##**Name**##
~This is the short name for the list ("test" in this example). You can modify it. For a longer description of the list, see ##List Description## below.
~Below ##name## is listed the number of users registered on the list ("64" in this example).

##**Order**##
~This is the order in which the list will appear on this page ("0" in this example). You can modify it. Several lists can have the same order number, in which case those lists will be ordered alphabetically ''(? verify)''

##**Functions**##
~There are several functions:

##**edit**##
~ To change the name, order, status (active/not active) and ownership of a list.

##**view members**##
~ To list and edit the [[UserInfo users]] on the list. For more, see [[ViewMembersInfo View members]].

##**delete**##
~ To delete a list. All Users subscribed to this list will no longer be subscribed to this list. You do not delete [[UserInfo users]] when you delete a list. To delete users, see ListUsersInfo.

##**Active**##
~Determines the status of the list: active/not active. If a list is inactive, no users will be able to subscribe to the list, as the list will not show up on the subscribe pages. It can however be used for internal purposes to organise your users, and you can send to it, as you can to any other list.

##**Owner**##
~This is the name of the [[EditAdminsInfo admin]] who owns the list ("admin" in this example). If you are not a superadmin and you change the ownership of the list, you will no longer have access to the list.

##**List Description**##
~Each list has a short ##Name##, but you can add a longer description for the list. Each list has a short ##Name##, but you can add a longer description for the list. This description will also appear on the [[ConfigureSubscribePageInfo subscribe page]]. You can include HTML formatting in the description, for example:

%%(html4strict)<b>I Love Theatre!</b> - If you are interested in drama, subscribe to this list.
Contact: <a href=mailto:drama@mysite.com>drama@mysite.com</a>%%

~will appear like this on the subscribe page:

~ ''**I Love Theatre!** - If you are interested in drama, subscribe to this list.
~ Contact: [[mailto:drama@mysite.com drama@mysite.com]]''

##**add a list**##
~This allows you to create a new list. The maximum number of lists each admin can create is determined by the site administrator (see PhplistConfiguration). For more, see below: ##Adding a list##.


====Adding or Editing a list ====

When you add or edit a list, you can choose the parameters defined above, namely:

##List name##
~This corresponds to a short ##Name## for the list, as defined above.

##Check this box to make active##
~See ##Active## above. This changes the "Active" status of the list.

##Order for listing##
~See ##Order## above. This will determine the order in which this list will appear when you list all lists. Several lists can have the same order number.

##**RSS Source** (validate) view items##
~Input an RSS source for this list (if the site administrator has allowed this feature). For more, see [[RssFunctionsInfo RSS Functions]]. Clicking on ##validate## will check whether the RSS feed complies with coding standards. Clicking on ##view items## will list the items tied to that RSS feed only.

##List description##
~This allows you to describe the list at length. The description will appear in the [[ConfigureSubscribePageInfo subscribe page]], and can contain text with HTML formatting. See example given above.

**Note:** To have a list appear on the [[ConfigureSubscribePageInfo subscribe page]], you must have access to the subscribe page. Adding a list here will not automatically add it to the subscribe page. Conversely, if you modify a list that //is already// on the subscribe page, your changes will automatically appear on the subscribe page.

##members of this list##
~See [[ViewMembersInfo View members]]. ##members of this list## and ##view members## lead to the same page.


====Working with various lists: Tips ====

~1)**Using private/public lists**: if you wish to filter your users manually to have better control of which users are on which lists, you can add them to lists that do not appear on the [[ConfigureSubscribePageInfo subscribe page]] (this is why these lists can be called "private" lists).
~1)**Making hierarchical lists**: you can choose to have a general list, then a more specialized list with only part of those who are on the general list, etc. This can be useful if you filter your lists, or if you create a process by which users go from one list to another, stage by stage.
~1)**Moving users between lists**: If you remove a user from a general and public list in order to subscribe him/her to a private list without informing her/him, he/she might wish to re-subscribe to the general and public list. You might prefer leaving the user in the public list and //adding// him/her to the private list. For more on moving users between lists, see [[ViewMembersInfo Tagging users]].
~1)**Number your lists** so that you have a better visual understanding of the hierarchy between your lists.

etc.


**Related pages**:
~-[[EditAdminsInfo Admins]]
~-[[ListUsersInfo Users]]
~-[[ViewMembersInfo View members]]
~-[[ExportUsersInfo Exporting Users]]
~-[[ConfigureSubscribePageInfo Subscribe Page]]
~-[[RssFunctionsInfo RSS Functions]]

----
CategoryDocumentation
Page was generated in 0.0304 seconds