source: extensions/event_cats/language/en_UK/help.html @ 4608

<!-- Keeps file coded in UTF-8 without BOM : é -->

<h1>Event Cats</h1>

<h3>Log in an account thanks to a single URL; duplicate an account</h3>

<h5><span style = "font-style:italic;">Display directly: <a href = "#principles">Principles</a>, <a href = "#tabs">Tabs</a>, <a href = "#acknowledgements">Acknowledgements</a></span></h5>

<h2><a name = "principles">Principles</a></h2>

<p>
  &nbsp;&nbsp;&nbsp;&nbsp;Event Cats allows to log in a user in Piwigo, without providing username and password <span style = "text-decoration:underline;">("autolog")</span>. It also allows that an account created by a visitor gets immediately the same access than another account <span style = "text-decoration:underline;">("duplication")</span>.<br />
<br />
  &nbsp;&nbsp;&nbsp;&nbsp;The purpose is to allow you, after an event where you "have been the photographer", to share your pictures a very simple way with people not having (yet) an account on your gallery, but still publishing your images in a <span style = "text-decoration:underline;">private</span> category. But maybe is there other ways to use it :-) ...
</p>
<hr width = "5%" align = "center">
<p>
  &nbsp;&nbsp;&nbsp;&nbsp;The automatic identification is carried out thanks to the "autolog" code, placed in the link that you give to the people whom you want to give access to. The visitors using this link find themselves directly logged in on your gallery under the <span style = "text-decoration:underline;">account associated</span> to the "autolog" code. The page displayed just after the identification can be:
  <ul>
    <li>home page;</li>
    <li>a category page;</li>
    <li>a picture;</li>
    <li>a page from plugin "<a href = "http://fr.piwigo.org/ext/extension_view.php?eid=153" title = "Open a window on plugin Additional Pages" onclick = "window.open(this.href); return false;">Additional Pages</a>", provided of course that this plugin is installed and activated, and that at least one of its page is available.</li>
  </ul>
  &nbsp;&nbsp;&nbsp;&nbsp;Once identified, your visitors can create an account&nbsp;&#151; a personal one&nbsp;&#151; having the same properties than the account under which they were previously identified. One can this way create his own account and have immediately access to private content on your gallery, without to wait for a validation from you. You can grant or deny account duplication, the same way you grant or deny access to a private category, selecting groups, account status, or accounts individually.
</p>
<p>
  &nbsp;&nbsp;&nbsp;&nbsp;The link (URL) allowing automatic identification on your gallery, is built as following:
  <ul><li style = "list-style-type:none;">http://<span style = "font-style:italic;">&#139;your gallery location&#155;</span><span style = "font-weight:bold;">&#38;autolog=<span style = "font-style:italic;">&#139;code&#155;</span></span></li></ul>
  &nbsp;&nbsp;&nbsp;&nbsp;When the user shall be redirected on another page than the home page, the following parameters are added: <span style = "font-weight:bold;">&#38;cat=<span style = "font-style:italic;">&#139;category identifier&#155;</span></span> for a category, <span style = "font-weight:bold;">&#38;img=<span style = "font-style:italic;">&#139;image identifier&#155;</span></span> for an image (in addition of category parameter), and <span style = "font-weight:bold;">&#38;ap=<span style = "font-style:italic;">&#139;Add. P. identifier&#155;</span></span> for a page from plugin Additional Pages. If an autolog URL is submitted with an <span style = "font-weight:bold;">&#38;img</span> parameter without category, the displayed page is the home page. If an autolog URL is submitted with both an <span style = "font-weight:bold;">&#38;ap</span> and a <span style = "font-weight:bold;">&#38;cat</span> parameter (with or without the <span style = "font-weight:bold;">&#38;img</span> parameter), the displayed page is the Additional Page.<br />
  <br />
  &nbsp;&nbsp;&nbsp;&nbsp;Event Cats allows you to manage a list of codes with different associations, kept into the database of your internet site. Each line with a code is an <span style = "font-weight:bold;font-style:italic;">entry</span> in Event Cats.<br />
</p>
<p></p>

<h2><a name = "tabs">Tabs</a></h2>

<p>
  &nbsp;&nbsp;&nbsp;&nbsp;Event Cats provides up to five tabs for its management:
  <ul>
    <li><a href = "#autolog_new">New autolog</a>;</li>
    <li><a href = "#autolog_entries">Autolog entries</a> <span style = "font-style:italic;">(when at least one "autolog" exists)</span>;</li>
    <li><a href = "#autolog_modif">Autolog modification</a> <span style = "font-style:italic;">(when at least one "autolog" exists)</span>;</li>
    <li><a href = "#duplication">Duplication</a> <span style = "font-style:italic;">(when "Duplication allowance" is set to "Per group selection")</span>;</li>
    <li><a href = "#config">Configuration</a>.</li>
  </ul>
</p>

<p>
  <h4><a name = "autolog_new">New autolog</a></h4>
  <p>
    &nbsp;&nbsp;&nbsp;&nbsp;This tab allows you to create the entries in the database. An entry associates a code to a user and to a page to display. It is possible to use a code several times, in the case it would be convenient to give access to different pages, to a same user. But a same code can of course be associated to only one user.<br />
    <br />
    &nbsp;&nbsp;&nbsp;&nbsp;When creating an entry, it is possible to create at the same time the account used in this entry. The accounts created by Event Cats are generic accounts, <span style = "font-style:italic;">ie</span> destinated to be used by several different users. The name of the account can be generated by Event Cats, provided that a page to display has been selected, as it is the title of the displayed page which is used to create the new account name. Event Cats can also create a group, which will be associated to, for instance, the selected category. Thus as the code itself can be generated by Event Cats too, it is possible to create an entry just by selecting a page to display and clicking on button "Full auto".<br />
    <br />
    &nbsp;&nbsp;&nbsp;&nbsp;As the page to display is mentioned in the URL (with the parameters <span style = "font-weight:bold;">&#38;cat=<span style = "font-style:italic;">&#139;category identifier&#155;</span></span>, <span style = "font-weight:bold;">&#38;img=<span style = "font-style:italic;">&#139;image identifier&#155;</span></span>, and <span style = "font-weight:bold;">&#38;ap=<span style = "font-style:italic;">&#139;Add. P. identifier&#155;</span></span>, see above), the user has the possibility to change the requested page, by modifying the URL. If the account associated to the code is not allowed to navigate into this page, Piwigo will definetely not display it&nbsp;&#151; no danger. But, to avoid the message "You are not authorized to access the requested page", you can set the displayed page to be "forced", meaning that Event Cats redirects the user on the page which you set at the entry creation, whatever are the parameters <span style = "font-weight:bold;">&#38;cat</span>, <span style = "font-weight:bold;">&#38;img</span>, and/or <span style = "font-weight:bold;">&#38;ap</span>, if there is any, in the requested URL.<br />
    &nbsp;&nbsp;&nbsp;&nbsp;If an entry is forced, its code can of course appear only once in the Event Cats entries list. Thus, making an entry "forced", requires to delete all other entries using the same code.<br />
    <br />
    &nbsp;&nbsp;&nbsp;&nbsp;The field "Comment" is completely optional, its only purpose is for you to record a small text (100 digits maximum), displayed in the entry list (tab <a href = "#autolog_entries">Autolog entries</a>) as tooltip or on a new line under the related code.
  </p>
  
  <h4><a name = "autolog_entries">Autolog entries</a></h4>
  <p>
    &nbsp;&nbsp;&nbsp;&nbsp;This tab, which is displayed when at least one "autolog" entry is available, allows you to monitor all the entries available in your database. When you select an entry, the related URL is displayed in the field "URL" to allow you to copy the automatic identification link, and to paste it for instance in an e-mail inteded to the people concerned in the event for which you want to share your pictures. With most of explorers, clicking on "URL" directly selects all the field, you just need to copy.<br />
    <br />
    &nbsp;&nbsp;&nbsp;&nbsp;The following tools are available in this page:
    <ul>
      <li style = "list-style-image:url(plugins/event_cats/icon/disable.png);">
        <span style = "font-weight:bold;">Make entry outdated</span>: this tool is used to make Event Cats recognize the "autolog" code, but <span style = "font-weight:bold;">not</span> log in a user.<br />When you click on this tool, the tab <a href = "#autolog_modif">Autolog modification</a> is displayed if the plugin Additional Pages is active; if not, the entry is directly modified with "Access denied" as displayed page (after a confirmation from you). This feature allows you to let a code active only for a certain time, after which late visitors will be redirected to the page you chose. Indeed using the autolog code can allow unwanted people to access to some private content, thus can it be convenient to suffer this risk only during a limited time. A perfect tool to warn visitors that you inted to make the URL not functional after some time, is the plugin <a href = "http://fr.piwigo.org/ext/extension_view.php?eid=190" title = "Open a new page on plugin PWG Suffs" onClick = "window.open(this.href);return false;">PWG Suffs</a>.
      </li>
      <li style = "list-style-image:url(plugins/event_cats/icon/forced.png);">
        <span style = "font-weight:bold;">Make the entry not forced any more</span>: this tool is equivalent to uncheck the checkbox "Forced" in tab <a href = "#autolog_modif">Autolog modification</a>. You will this way be allowed to create other entries using the same code; and users of this URL will be able to try to modify it (see <a href = "#autolog_new">New autolog</a> above).
      </li>
      <li style = "list-style-image:url(plugins/event_cats/icon/nforced.png);">
        <span style = "font-weight:bold;">Force entry</span>: this tool makes the displayed page forced for an entry (see <a href = "#autolog_new">New autolog</a> above).
      </li>
      <li style = "list-style-image:url(plugins/event_cats/icon/duplicate.png);">
        <span style = "font-weight:bold;">Copy entry</span>: this tool navigates to tab <a href = "#autolog_new">New autolog</a> and directly selects in it the entry to copy, this to create a new entry using the same code, but heading the (same, of course) identified user to a different displayed page.
      </li>
      <li style = "list-style-image:url(plugins/event_cats/icon/url2.png);">
        <span style = "font-weight:bold;">Test URL</span>: this tool allows you to check that the URL works as planned. Be careful: using this link disconnects you from your site as administrator, of course.
      </li>
      <li style = "list-style-image:url(plugins/event_cats/icon/delete.png);">
        <span style = "font-weight:bold;">Delete entry</span>: deletes the entry :-/ .<br />Note that if a visitor uses a URL including an "autolog" code which doesn't exist in the database (thus for instance a code that you would have communicated during a period, and deleted), you can choose in tab <a href = "#config">Configuration</a> to which page (s)he will be redirected.
      </li>
      <li style = "list-style-image:url(plugins/event_cats/icon/modify.png);">
        <span style = "font-weight:bold;">Modify entry</span>: this tool navigates to tab <a href = "#autolog_modif">Autolog modification</a> and directly selects in it the entry to modify.
      </li>
    </ul>
  </p>
  <h4><a name = "autolog_modif">Autolog modification</a></h4>
  <p>
    &nbsp;&nbsp;&nbsp;&nbsp;This tab, also available only when at least one "autolog" entry exists for your gallery, allows you to modify an entry (indeed...). Unlike during entry creation, you can here make an entry "outdated", by choosing "None" as "Identified user" or "Access denied" as "Displayed page". If "None" is selected as "Identified user", and plugin Additional Pages can be used, it is possible to choose an Additional Page as displayed page. You are this way able to make a code inactive, but displaying a personnalized explanation (see help on <img src = "plugins/event_cats/icon/disable.png">&nbsp;<span style = "font-weight:bold;">Make entry outdated</span> in section <a href = "#autolog_entries">Autolog entries</a>).
  </p>
  <h4><a name = "duplication">Duplication</a></h4>
  <p>
    &nbsp;&nbsp;&nbsp;&nbsp;This tab is available only when parameter "Duplication allowance" is set to "Per group selection". As a matter of fact, it is useless when duplication is allowed to all accounts, or to none.<br />
    &nbsp;&nbsp;&nbsp;&nbsp;It allows you to monitor duplication: which accounts will it be possible to duplicate, and the way the duplication link will be displayed. Selecting the accounts is done exactly the same way as in administration page "Manage permissions for a category" (as simple as copying this page :-/ ...).<br />
    &nbsp;&nbsp;&nbsp;&nbsp;The way the duplication link is displayed, allows mainly to treat gently the users identified with a generic account (Event Cats creates only generic accounts): if a visitor used a link activating an "autolog" code, (s)he is identified without having to provide a username and a password. On the face of it (s)he has no clue (s)he can "copy" this account, and therefore it is useless to suggest "duplication", a word which can show itself not understandable at this moment. The user is simply given the possibility to "Register", and, without a word about it, if (s)he registers (though (s)he is already identified), (s)he gets immediately the same access than the account with which (s)he was previously identified, and is this way is allowed to continue to navigate on your gallery in the same categories than the account associated to the "autolog" code you had provided, but with his (her) personnal account, together with the related facilities: personnalization, comments with the account name... Registration is done exactly the same way as normally, and you're warned that your gallery counts a new user. As a matter of fact, the e-mail precises "Identified user:", showing with which account was identified the new user, when (s)he registered, if it was after an "autolog". There is currently no known conflict with plugin <a href = "http://fr.piwigo.org/ext/extension_view.php?eid=216" title = "Open a new window on plugin NBC UserAdvManager" onClick = "window.open(this.href);return false;">NBC UserAdvManager</a> (advanced users management).
  </p>
  <h4><a name = "config">Configuration</a></h4>
  <p>
    &nbsp;&nbsp;&nbsp;&nbsp;This last tab allows to manage the following parameters:
    <ul>
      <li><span style = "font-weight:bold;">Duplication</span>: same parameters than in tab <a href = "#duplication">Duplication</a>;</li>
      <li><span style = "font-weight:bold;">Unknown code</span>: the page wich must be displayed in the case a visitor uses a URL including an "autolog" code which does not appear in your database (thus, for instance, in the case of using a code you deleted);</li>
      <li><span style = "font-weight:bold;">Other</span>:
        <ul>
          <li>you can record a comment for each entry: in tab <a href = "#autolog_entries">Autolog entries</a>, it can be displayed as tooltip, or below the codes;</li>
          <li>if the help banner is activated, it will be showed each time you navigate into a tab; otherwise it will remain hided;</li>
          <li>if you communicate a URL to log in automatically a generic account, to some people who already have their own account on your gallery, it can be convenient for these people to log in as usually, using the "Log in" link.</li>
        </ul>
      </li>
    </ul>
  </p>
</p>
<p></p>

<h2><a name = "acknowledgements">Acknowledgements</a></h2>

<p>
  <ul>
    <li><a href = "http://www.gauchon.fr" title = "Open a new window on P@t's site" onClick = "window.open(this.href);return false;">P@t</a> provided the features code; without him, Event Cats would not exist ;-)&nbsp;!&nbsp;&nbsp;;</li>
    <li><a href = "http://piwigo.org/forum/profile.php?id=3572" title = "Open a new window on ddtddt's profile" onClick = "window.open(this.href);return false;">ddtddt</a> and <a href = "http://www.vdigital.org" title = "Open a new window on VDigital's site" onClick = "window.open(this.href);return false;">VDigital</a> helped accelerating the developement of this plugin... (yes, it would have been <span style = "font-style:italic;">indeed</span> longer without them...);</li>
    <li><a href = "http://www.julien-moreau.fr" title = "Open a new window on Gotcha's site" onClick = "window.open(this.href);return false;">Gotcha</a> made all his possible to slow me... by making me correct all that was less nice ;-)&nbsp;&nbsp;;</li>
    <li><a href = "http://piwigo.wordpress.com" title = "Open a new window on plg's blog" onClick = "window.open(this.href);return false;">plg</a> also contributed somewhere, but the hell if I remember where ??...;</li>
    <li>and globally speaking, the forum (flipflip, flop25...), nothing nicer to go forward!</li>
    <li>And, last but not least, <span style = "font-weight:bold;">you</span>: by downloading this plugin; if possible using it; and eventually posting remarks, comments, features requirements: <a href = "http://piwigo.org/forum/viewtopic.php?id=15622" title = "Open a new window on Event Cats discussion" onClick = "window.open(this.href);return false;">Event Cats discussion on Piwigo forum</a>.</li>
  </ul>
</p>