Web Script: org/alfresco/components/documentlibrary/documentlist.get
Generated from /share/service/script/org/alfresco/components/documentlibrary/documentlist.get on Jun 15, 2026 4:41:16 PM

Script Properties
Id:org/alfresco/components/documentlibrary/documentlist.get
Short Name:DocLib DocumentList
Description:Document Library: Document List Component
Authentication:none
Transaction:none
Method:GET
URL Template:/components/documentlibrary/documentlist
Format Style:any
Default Format:html
Negotiated Formats:[undefined]
Implementation:class org.alfresco.web.scripts.DeclarativeWebScript
Extensions:[undefined]

Store: classpath:alfresco/site-webscripts

File: org/alfresco/components/documentlibrary/documentlist.get.desc.xml
<webscript>
  <shortname>DocLib DocumentList</shortname>
  <description>Document Library: Document List Component</description>
  <url>/components/documentlibrary/documentlist</url>
</webscript>
File: org/alfresco/components/documentlibrary/documentlist.get.head.ftl
<!-- Document List Assets -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/components/documentlibrary/documentlist.css" />
<script type="text/javascript" src="${page.url.context}/components/documentlibrary/documentlist.js"></script>
<!-- Document Preview -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/modules/document-preview.css" />
<script type="text/javascript" src="${page.url.context}/modules/document-preview.js"></script>
<!-- Simple Dialog Assets -->
<script type="text/javascript" src="${page.url.context}/modules/simple-dialog.js"></script>
<!-- Copy-To Assets -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/modules/documentlibrary/copy-to.css" />
<script type="text/javascript" src="${page.url.context}/modules/documentlibrary/copy-to.js"></script>
<!-- Move-To Assets -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/modules/documentlibrary/move-to.css" />
<script type="text/javascript" src="${page.url.context}/modules/documentlibrary/move-to.js"></script>
<!-- Details Assets -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/modules/documentlibrary/details.css" />
<script type="text/javascript" src="${page.url.context}/modules/documentlibrary/details.js"></script>
<!-- Assign Workflow Assets -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/modules/documentlibrary/workflow.css" />
<script type="text/javascript" src="${page.url.context}/modules/documentlibrary/workflow.js"></script>
<!-- People Finder Assets (req'd by Assign Workflow) -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/components/people-finder/people-finder.css" />
<script type="text/javascript" src="${page.url.context}/components/people-finder/people-finder.js"></script>
<!-- Manage Permissions Assets -->
<link rel="stylesheet" type="text/css" href="${page.url.context}/modules/documentlibrary/permissions.css" />
<script type="text/javascript" src="${page.url.context}/modules/documentlibrary/permissions.js"></script>
File: org/alfresco/components/documentlibrary/documentlist.get.html.ftl
<#macro initialFilter>
   <#assign filterId = page.url.args["filter"]!"path">
   <#assign filterOwner>Alfresco.DocList<#if filterId == "path">Tree<#elseif filterId == "tag">Tags<#else>Filter</#if></#assign>
      initialFilter:
      {
         filterId: "${filterId}",
         filterOwner: "${filterOwner}"
      },
</#macro>
<!--[if IE]>
   <iframe id="yui-history-iframe" src="${url.context}/yui/assets/blank.html"></iframe> 
<![endif]-->
<input id="yui-history-field" type="hidden" />
<script type="text/javascript">//<![CDATA[
   new Alfresco.DocumentList("${args.htmlid}").setOptions(
   {
      siteId: "${page.url.templateArgs.site!""}",
      containerId: "${args.container!"documentLibrary"}",
      initialPath: "${page.url.args["path"]!""}",
      <@initialFilter />
      usePagination: ${(args.pagination!false)?string},
      highlightFile: "${page.url.args["file"]!""}",
      showFolders: ${(preferences.showFolders!false)?string},
      simpleView: ${(preferences.simpleView!false)?string},
      highlightFile: "${page.url.args["file"]!""}"
   }).setMessages(
      ${messages}
   );
//]]></script>
<div id="${args.htmlid}-body" class="doclist">
   <div id="${args.htmlid}-doclistBar" class="yui-gc doclist-bar flat-button">
      <div class="yui-u first">
         <div class="file-select">
            <button id="${args.htmlid}-fileSelect-button" name="doclist-fileSelect-button">${msg("menu.select")}</button>
            <div id="${args.htmlid}-fileSelect-menu" class="yuimenu">
               <div class="bd">
                  <ul>
                     <li><span><span class="selectDocuments">${msg("menu.select.documents")}</span></span></li>
                     <li><span><span class="selectFolders">${msg("menu.select.folders")}</span></span></li>
                     <li><span><span class="selectAll">${msg("menu.select.all")}</span></span></li>
                     <li><span><span class="selectInvert">${msg("menu.select.invert")}</span></span></li>
                     <li><span><span class="selectNone">${msg("menu.select.none")}</span></span></li>
                  </ul>
               </div>
            </div>
         </div>
         <div id="${args.htmlid}-paginator" class="paginator"></div>
      </div>
      <div class="yui-u align-right">
         <button id="${args.htmlid}-showFolders-button" name="doclist-showFolders-button">${msg("button.folders.show")}</button>
         <span class="separator">&nbsp;</span>
         <button id="${args.htmlid}-simpleView-button" name="doclist-simpleView-button">${msg("button.view.simple")}</button>
      </div>
   </div>

   <div id="${args.htmlid}-documents" class="documents"></div>

   <div id="${args.htmlid}-doclistBarBottom" class="yui-gc doclist-bar doclist-bar-bottom flat-button">
      <div class="yui-u first">
         <div class="file-select">&nbsp;</div>
         <div id="${args.htmlid}-paginatorBottom" class="paginator"></div>
      </div>
   </div>

   <!-- Action Sets -->
   <div style="display:none">
      <!-- Action Set "More..." container -->
      <div id="${args.htmlid}-moreActions">
         <div class="onActionShowMore"><a href="#" class="show-more" title="${msg("actions.more")}"><span>${msg("actions.more")}</span></a></div>
         <div class="more-actions hidden"></div>
      </div>
      
      <#--
         IMPORTANT: Do not add linefeeds between tags on individual actions as this will break DOM parsing code.
         (See note in documentlist.js)
      -->
      <!-- Action Set Templates -->
      <div id="${args.htmlid}-actionSet-empty" class="action-set">
      </div>

      <div id="${args.htmlid}-actionSet-document" class="action-set">
         <div class="onActionDownload"><a rel="" href="{downloadUrl}" class="simple-link" title="${msg("actions.document.download")}"><span>${msg("actions.document.download")}</span></a></div>
         <div class="onActionDetails"><a rel="edit" href="#" class="action-link" title="${msg("actions.document.details")}"><span>${msg("actions.document.details")}</span></a></div>
         <div class="onActionEditOnline"><a rel="edit,online-edit" href="#" class="action-link" title="${msg("actions.document.edit-online")}"><span>${msg("actions.document.edit-online")}</span></a></div>
         <div class="onActionEditOffline"><a rel="edit" href="#" class="action-link" title="${msg("actions.document.edit-offline")}"><span>${msg("actions.document.edit-offline")}</span></a></div>
         <div class="onActionCopyTo"><a rel="" href="#" class="action-link" title="${msg("actions.document.copy-to")}"><span>${msg("actions.document.copy-to")}</span></a></div>
         <div class="onActionMoveTo"><a rel="delete" href="#" class="action-link" title="${msg("actions.document.move-to")}"><span>${msg("actions.document.move-to")}</span></a></div>
         <div class="onActionDelete"><a rel="delete" href="#" class="action-link" title="${msg("actions.document.delete")}"><span>${msg("actions.document.delete")}</span></a></div>
         <div class="onActionAssignWorkflow"><a rel="" href="#" class="action-link" title="${msg("actions.document.assign-workflow")}"><span>${msg("actions.document.assign-workflow")}</span></a></div>
         <div class="onActionManagePermissions"><a rel="permissions" href="#" class="action-link" title="${msg("actions.document.manage-permissions")}"><span>${msg("actions.document.manage-permissions")}</span></a></div>
      </div>

      <div id="${args.htmlid}-actionSet-locked" class="action-set">
         <div class="onActionDownload"><a rel="" href="{downloadUrl}" class="simple-link" title="${msg("actions.document.download")}"><span>${msg("actions.document.download")}</span></a></div>
      </div>

      <div id="${args.htmlid}-actionSet-lockOwner" class="action-set">
         <div class="onActionDownload"><a rel="" href="{downloadUrl}" class="simple-link" title="${msg("actions.document.download-original")}"><span>${msg("actions.document.download-original")}</span></a></div>
      </div>

      <div id="${args.htmlid}-actionSet-workingCopyOwner" class="action-set">
         <div class="onActionUploadNewVersion"><a href="#" class="action-link" title="${msg("actions.document.upload-new-version")}"><span>${msg("actions.document.upload-new-version")}</span></a></div>
         <div class="onActionDownload"><a rel="" href="{downloadUrl}" class="simple-link" title="${msg("actions.document.download-again")}"><span>${msg("actions.document.download-again")}</span></a></div>
         <div class="onActionCancelEditing"><a rel="" href="#" class="action-link" title="${msg("actions.document.cancel-editing")}"><span>${msg("actions.document.cancel-editing")}</span></a></div>
      </div>

      <div id="${args.htmlid}-actionSet-folder" class="action-set">
         <div class="onActionDetails"><a rel="edit" href="#" class="action-link" title="${msg("actions.document.details")}"><span>${msg("actions.document.details")}</span></a></div>
         <div class="onActionCopyTo"><a rel="" href="#" class="action-link" title="${msg("actions.folder.copy-to")}"><span>${msg("actions.folder.copy-to")}</span></a></div>
         <div class="onActionMoveTo"><a rel="delete" href="#" class="action-link" title="${msg("actions.folder.move-to")}"><span>${msg("actions.folder.move-to")}</span></a></div>
         <div class="onActionDelete"><a rel="delete" href="#" class="action-link" title="${msg("actions.folder.delete")}"><span>${msg("actions.folder.delete")}</span></a></div>
         <div class="onActionManagePermissions"><a rel="permissions" href="#" class="action-link" title="${msg("actions.document.manage-permissions")}"><span>${msg("actions.document.manage-permissions")}</span></a></div>
      </div>

      <div id="${args.htmlid}-actionSet-link" class="action-set">
         <div class="onActionDelete"><a rel="delete" href="#" class="action-link" title="${msg("actions.link.delete")}"><span>${msg("actions.link.delete")}</span></a></div>
      </div>
   </div>

</div>
File: org/alfresco/components/documentlibrary/documentlist.get.js
const PREFERENCES_ROOT = "org.alfresco.share.documentList";

/**
 * Main entrypoint for component webscript logic
 *
 * @method main
 */
function main()
{
   var result, preferences = {};
   
   // Request the current user's preferences
   var result = remote.call("/api/people/" + stringUtils.urlEncode(user.name) + "/preferences?pf=" + PREFERENCES_ROOT);
   if (result.status == 200)
   {
      var prefs = eval('(' + result + ')');
      try
      {
         // Populate the preferences object literal for easy look-up later
         preferences = eval('(prefs.' + PREFERENCES_ROOT + ')');
         if (typeof preferences != "object")
         {
            preferences = {};
         }
      }
      catch (e)
      {
      }
   }

   model.preferences = preferences;
}

main();
File: org/alfresco/components/documentlibrary/documentlist.get.properties
## Buttons
button.folders.show=Show Folders
button.folders.hide=Hide Folders
button.view.simple=Simple View
button.view.detailed=Detailed View

## Drop-down Menus
menu.select=Select
menu.select.all=All
menu.select.none=None
menu.select.invert=Invert Selection
menu.select.folders=Folders
menu.select.documents=Documents

## Document Details
details.link-to=Link to: {0}
details.created.on=Created on:
details.created.by=Created by:
details.modified.on=Modified on:
details.modified.by=Modified by:
details.checked-out.on=Checked out on:
details.checked-out.by=Checked out by:
details.by=By:
details.version=Version:
details.size=Size:
details.description=Description:
details.description.none=(None)
details.comments=Comments:
details.tags=Tags:
details.tags.none=(None)

## Actions
actions.document.rename=Rename
actions.folder.rename=Rename
actions.document.details=Edit Metadata
actions.document.copy-to=Copy to...
actions.document.move-to=Move to...
actions.document.delete=Delete Document
actions.document.download=Download
actions.document.download-again=Download
actions.document.download-original=Download Original
actions.document.edit-offline=Edit Offline
actions.document.edit-online=Edit Online
actions.document.cancel-editing=Cancel Editing
actions.document.upload-new-version=Upload New Version
actions.document.assign-workflow=Assign Workflow...
actions.document.manage-permissions=Manage Permissions...
actions.link.delete=Delete Link
actions.folder.details=Details
actions.folder.copy-to=Copy to...
actions.folder.move-to=Move to...
actions.folder.delete=Delete Folder
actions.more=More...

## Tips
tip.locked=Locked by {0} ({1})
tip.editing=Being edited by you
tip.lock-owner=Locked by you
tip.active-workflow=Belongs to {0} active workflows

## Pop-up Messages
message.confirm.delete=Are you sure you want to delete '{0}'?
message.delete.success='{0}' was deleted
message.delete.failure=Could not delete '{0}'
message.edit-offline.success='{0}' can now be edited
message.edit-offline.success.ie7=Download the document using the button below.
message.edit-offline.failure=You cannot edit '{0}'.
message.edit-cancel.success=Editing '{0}' has been cancelled
message.edit-cancel.failure=Could not cancel editing '{0}'.
message.loading=Loading the Document Library...
message.error=Could not access the Document Library
message.empty=No items

## File Upload (upload new version)
label.filter-description=Same type as {0}

Store: classpath:alfresco/webscripts

[No implementation files]