Uploaded image for project: 'DSpace'
  1. DSpace
  2. DS-3982

Missing documentation in mail templates

    XMLWordPrintable

    Details

    • Attachments:
      0
    • Comments:
      1
    • Documentation Status:
      Needed

      Description

      In most of the mails under https://github.com/DSpace/DSpace/tree/master/dspace/config/emails, there is a header describing the different parameters used in the mail template.

      For https://github.com/DSpace/DSpace/blob/master/dspace/config/emails/request_item.author and https://github.com/DSpace/DSpace/blob/master/dspace/config/emails/request_item.admin, this header is not available which does not make it really intuitive to change the mail template, especially for request_item.author.

       

      Hereunder, the parameters to include in the header for request_item.author :

      {0} Name of the requester of the file {1} The email of the requester of the file {2} Either the term "All files" of the url to a single file {3} Url to the item {4} Title of the item {5} The message that the requester entered {6} The link for the submitter/admin where he/she can reply {7} The name of the user receiving this email {8} The email of the user receiving this email {9} The dspace name (dspace.name config property) {10} The helpdesk mail (mail.helpdesk config property)

       

      and the parameters for request_item.admin : 
      {0}

      : File ID

      {1}

      : Document Handle

      {2}

      : Token

      {3}

      : Name of the requester of the file

      {4}

      The email of the requester of the file

        Attachments

          Activity

            People

            Assignee:
            Unassigned
            Reporter:
            david.atmire David Cavrenne (Atmire)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated: