DOCman

DOCman

  • Changing Ordering Options for DOCman Menu Items and Modules

    Menu Item

    To reorder DOCman documents displayed by a menu item:

    1. Log into the back-end Administrator interface.
    2. Go to Menus.
    3. Click the name of the menu containing the menu item that links to DOCman.
    4. Open the menu item that matches the page to be edited.  This should be similar to the name of item in the horizontal navigation bar.
    5. Click the DOCman tab (see #1 below).
    6. In the "Sort documents by" dropdown, choose method to sort documents.(see #2 below).
    7. Click Save & Close (see #3 below).

    Select sort criteria for DOCman menu item

    Module

    To reorder DOCman documents displayed by a module:

    1. Log into the back-end Administrator interface.
    2. Go to Extension -> Modules.
    3. Click Search Tools.
    4. In the Select Type dropdown, choose "DocMan - Documents". 
    5. Click the title of the module to be adjusted.
    6. The screen that shows should have an "Order by" field (see #1 below).
    7. Select a new ordering option.  "Ordering" is the order they appear in the DocMan component which is the same place you upload files and create DocMan documents (see #2 below).
    8. Click Save & Close(see #3 below).

    Select sort criteria for DOCman module

    If you cannot find the Menu Item or Module, submit an SASIT workorder.

  • Creating a "DOCman - Documents" module

    Overview

    You can display a list of documents from the same category within a "DOCman - Documents" module. When new documents are added to the category, the module will automatically update the list.

    Procedure

    1. In the Joomla! back-end (Control Panel), navigate to Extensions > Modules, then click the New Button to create a new module:
      Creating a new module
    2. Select DOCMan - Documents from the list that appears under "Select a Module Type:"
      Select a module type: "DOCman - Documents"
    3. Enter a Title for your module (see #1 below).
    4. Click within the Categories field and select your DOCMan category (see #2 below).
    5. For "Position," click the dropdown menu, and select the desired module position.  For example, to display the module to the right of the content area, select "Sidebar-b [sidebar-b]". Read more about Module Positions here.
    6. Click the "Menu Assignment" menu to specify which menu items will display your module (see #3 below).
    7. Click Save & Close to the upper left (see #4 below).

    Creating a "DOCMan -Documents" Module

     

  • Creating a "DOCman - Documents" module (Joomla! 4/5)

    Overview

    You can display a list of documents from the same category within a "DOCman - Documents" module. When new documents are added to the category, the module will automatically update the list.

    Procedure

    1. In the Joomla! back-end (Control Panel), navigate to Extensions > Site Modules, then click the New Button to create a new module:
      Creating a new module
    2. Select DOCMan - Documents from the list that appears under "Select a Module Type:"
      Selecting module type: "DOCman - Documents"
    3. Enter a Title for your module (see #1 below).
    4. Click within the Categories field and select your DOCMan category (see #2 below).
    5. For "Position," click the dropdown menu, and select the desired module position.  For example, to display the module to the left of the content area, select "Sidebar-left [sidebar-left ]". Read more about Module Positions here.
    6. Click the "Menu Assignment" menu to specify which menu items will display your module (see #3 below).
    7. Click Save & Close to the upper left (see #4 below).

    Screenshot 2023 06 20 at 12.41.16 PM

  • Creating and Using Categories in DocMan (Joomla! 4/5)

    This procedure explains how to create DOCman categories and move documents into them, using the SAS Content Management System (CMS; Joomla! 3.x) with the DOCman document manager component for Joomla! installed.


    1. Creating a Document Category

    • Log on to your site's Administrator URL.
    • Select "Components > DocMan > Categories":

      Screenshot 2023 06 15 at 1.47.23 PM

    • Click the New icon to the upper left of the page: DOCman "New" button

    • Type a name for your new category in the title field (see #1 below).
    • (Optional) Select a Parent Category if you want the category to be located within an existing category (see #2 below).
    • (Optional) Enter a description for your category in the description text box (see #3 below).
    • Save the new category by clicking the Save & Closeicon to the upper left (see #4 below).

      DOCman: Create a category

    2. Moving a Document to Your New Category

    • Select "Components > DocMan > Documents":

      Screenshot 2023 06 06 at 2.44.02 PM

    • Click on the title of a document that you want to move.
    • Click the Category dropdown menu and select your new category (see #1 below).
    • Click the Save & Closeicon to the upper left (see #2 below).

    DOCman: Change document category

    Your document can now be found in the new category you created.

  • Linking to DocMan Documents (Joomla! 3.x)

    This procedure explains how to create links to DOCman documents within articles, on web sites using the SAS Content Management System (CMS; Joomla! 3.x).


    Linking to Documents:

    • Edit the article in which you want to create the link to the DocMan document (see: Editing Articles (Joomla! 3.x, front-end) - Basic Editing)
    • Click the "Document" button below the text area:

      DOCman: Document button

    • A popup window will appear.  Under "Menu Items and categories" on the left, click on the category containing the document you want to link to: (see #1 below).
    • Click on the name of the document you want to link to (see #2 below).
    • If the link text should differ from the document name, edit the text in the File name field on the right (see #3 below).
    • Click Insert document link (see #4 below).

      Inserting a DOCman document link
    • A link to the document will appear in your article.
    • Click the Saveicon in the upper left corner of the page: Save button

      or click Save & Close to save your changes and close the article: Save and Close
  • Linking to DocMan Documents (Joomla! 4/5)

    This procedure explains how to create links to DOCman documents within articles, on web sites using the SAS Content Management System (CMS; Joomla! 4.x).


    Linking to Documents:

    • Edit the article in which you want to create the link to the DocMan document (see: Basic Editing (front-end))
    • Click the "Document" button below the text area:

      Screenshot 2023 06 15 at 12.20.49 PM

    • A popup window will appear.  Under "Menu Items and categories" on the left, click on the category containing the document you want to link to: (see #1 below).
    • Click on the name of the document you want to link to (see #2 below).
    • If the link text should differ from the document name, edit the text in the File name field on the right (see #3 below).
    • Click Insert document link (see #4 below).

      Screenshot 2023 06 20 at 11.59.32 AM
    • A link to the document will appear in your article.
    • Click the Saveicon in the upper left corner of the page: Screenshot_2023-06-15_at_12.26.10_PM.png

      or click Save & Close to save your changes and close the article: Screenshot_2023-06-15_at_12.26.28_PM.png
  • Listing DOCman Documents within an Article

    Overview

    You can display a list of documents from the same category within an article. The list will automatically update as new documents are added to the category.

    Create "DOCman - Documents" module

    1. Go to Extensions > Modules
    2. Click the green New button to the upper left
    3. Select DOCMan - Documents
    4. Enter the Title for your module (see #1 below)
    5. Click within the Categories field and select your DOCMan category (see #2 below)
    6. Click Save & Close to the upper left (see #3 below)

    DOCMan Module

    Embed the "DOCman - Documents" module in an article

    1. In the Joomla! Administrator page, click Content > Articles
    2. Find and click on your article you want your list of documents in
    3. Click at where you want your list to display, and then click the Module button below the content area (third button from the left)
    4. In the - Select Type - dropdown menu, select "DOCMan - Documents"
    5. Click on the ID number of the new module you created
    6. Click Save & Close icon to the upper left to save your article
    7. Your article will now display a list of all the documents in your selected DOCMan Category
  • Listing DOCman Documents within an Article (Joomla! 4/5)

    Overview

    You can display a list of documents from the same category within an article. The list will automatically update as new documents are added to the category.

    Create "DOCman - Documents" module

    1. Go to Extensions > Modules
    2. Click the green New button to the upper left
    3. Select DOCMan - Documents
    4. Enter the Title for your module (see #1 below)
    5. Click within the Categories field and select your DOCMan category (see #2 below)
    6. Click Save & Close to the upper left (see #3 below)

    Screenshot 2023 06 15 at 3.00.22 PM

    Embed the "DOCman - Documents" module in an article

    1. In the Joomla! Administrator page, click Content > Articles
    2. Find and click on your article you want your list of documents in
    3. Click at where you want your list to display, and then click the Module button below the content area (third button from the left)
    4. In the - Select Type - dropdown menu, select "DOCMan - Documents"
    5. Click on the ID number of the new module you created
    6. Click Save & Close icon to the upper left to save your article
    7. Your article will now display a list of all the documents in your selected DOCMan Category
  • Overview: What is DOCMan?

    • How to video:

    Overview

    DOCMan is an extension for Joomla! that allows you to upload documents to your website, so they can then be downloaded by visitors to your site.

    File vs. Document

    DOCMan defines files and documents as different things:

    • A file is the original PDF, Word document, or other file that you upload to DOCman.  Your file is not accessible on the website until it becomes a document.
    • A document is a link to the file you uploaded, with some additional properties that are specified in DOCMan:
      • A title (which may differ from the file name)
      • A category
      • A description (optional)
      • The status, whether published or unpublished

    DOCman: File is uploaded to DOCman; file becomes document; document displayed on website

    DOCman Documentation

    • Video Included: Video Included
  • Overview: What is DOCMan? (Joomla! 4/5)

    • How to video:

    Overview

    DOCMan is an extension for Joomla! that allows you to upload documents to your website, so they can then be downloaded by visitors to your site.

    File vs. Document

    DOCMan defines files and documents as different things:

    • A file is the original PDF, Word document, or other file that you upload to DOCman.  Your file is not accessible on the website until it becomes a document.
    • A document is a link to the file you uploaded, with some additional properties that are specified in DOCMan:
      • A title (which may differ from the file name)
      • A category
      • A description (optional)
      • The status, whether published or unpublished

    DOCman: File is uploaded to DOCman; file becomes document; document displayed on website

    DOCman Documentation

    • Video Included: Video Included
  • Overview: Where does Joomla store files? (Joomla! 4/5)

    Overview

    In Joomla!, files such as PDFs and images (jpg, png, etc) are all stored in the "images" directory.  The exception is for files uploaded using a third-party document management extension such as DOCman.  These extensions have their own folder structure within the Joomla! website.

    There are multiple ways to upload these files; follow the appropriate links below.

    Uploading files to the "images" folder

    The Media Manager in Joomla! and JCE Editor Pro both allow you to upload files to the "images" folder.

    Media - for image files (gif, jpg, png, etc).

    JCE Editor File Browser - for PDF files

    Uploading files with third-party extensions

    DOCman, Ignite Gallery, and JEvents are all examples of third-party extensions that allow you to upload files to Joomla!.  The files are stored by the respective components within their own file structures, not the "images" folder.

    DOCman

    Ignite Gallery

    JEvents

  • Unpublishing and Re-Publishing a Document (joomla 3)

    Overview

    In DOCman, you can unpublish a document without deleting it from your web site.  If you need to display the document again, you can easily re-publish it.

    Procedure

    1. In the Administrator interface, select Components > DOCMan > Documents:
      Components - DOCman - Documents
    2. If the document to be unpublished doesn't appear in the list, select the category containing the document from CATEGORIES > All Categories (see #1 below).
    3. Click the check box to the left of your document's name (see #2 below).
    4. Click the Unpublish button above the list of documents (see #3 below).
    5. The "Status" column will display "Unpublished" for your document, meaning that it will no longer be visible from the front-end of the web site.
    6. If you need to publish it again, click the check box to the left of your document name (see #2 below).
    7. Click the Publish button above the list of documents (see #4 below).Unpublishing and Publishing Documents in DOCman

     

  • Unpublishing and Re-Publishing a Document (Joomla! 4/5)

    Overview

    In DOCman, you can unpublish a document without deleting it from your web site.  If you need to display the document again, you can easily re-publish it.

    Procedure

    1. In the Administrator interface, select Components > DOCMan > Documents:
      Screenshot_2023-06-06_at_2.44.02_PM.jpg
    2. If the document to be unpublished doesn't appear in the list, select the category containing the document from CATEGORIES > All Categories (see #1 below).
    3. Click the check box to the left of your document's name (see #2 below).
    4. Click the Unpublish button above the list of documents (see #3 below).
    5. The "Status" column will display "Unpublished" for your document, meaning that it will no longer be visible from the front-end of the web site.
    6. If you need to publish it again, click the check box to the left of your document name (see #2 below).
    7. Click the Publish button above the list of documents (see #4 below).Screenshot 2023 06 15 at 12.40.22 PM

  • Updating DOCman Documents with New Files (Joomla! 4)

    This document explains how to update published DOCman documents with new files, on web sites using the SAS Content Management System (CMS; Joomla! 3.x) with the DOCman document manager component for Joomla! installed.


    1. Updating a Document with a New File of the Same Name

    If you need to upload an updated version of a file after you have already uploaded and published it to your web site, all you need to do is replace the original file:

    • Click on the "Components" menu, and select "DocMan" > "Files:"

      Screenshot 2023 06 06 at 2.44.02 PM
    • Click on the Upload button at the top 
    • You can either drag your file to the Drop files here area in the middle of the Files page (see #1 below), or click the Upload button (see #2 below).
    • If you clicked the Upload button, locate your document in the File Upload window. When you find the file, click Open or double click on the file.

      Screenshot 2023 06 20 at 12.57.22 PM

    • Click OK when asked if you want to overwrite the file with the same name that already exists:

      DOCman: Overwrite Existing File

    • Your document should now be updated with the new file.

    2. Updating a Document with a New File of a Different Name

    You may need to replace a DOCman document with a file of a different name.  The process is similar to the above, but with a few extra steps.

    • Click on the "Components" menu, and select "DocMan > Documents"

      Screenshot 2023 06 06 at 2.44.02 PM

    • Click on update at the top
    • You can either drag your file to the "Drop another file to update area" (see #1 below), or click the Update button (see #2 below).
    • If you clicked the Update button, locate your document in the File Upload window. When you find the file, click Open.
    • Click the Save & Closebutton at the top (see #3 below).

      Update DOCman document with new file of different name

    • Your document should now be updated with the new file.
  • Updating DOCman Documents with New Files (Joomla! 5)

    This document explains how to update published DOCman documents with new files, on web sites using the SAS Content Management System (CMS; Joomla! 3.x) with the DOCman document manager component for Joomla! installed.


    1. Updating a Document with a New File of the Same Name

    If you need to upload an updated version of a file after you have already uploaded and published it to your web site, all you need to do is replace the original file:

    • Click on the "Components" menu, and select "DocMan" > "Files:"

      Screenshot 2023 06 06 at 2.44.02 PM
    • Click on the Upload button at the top 
    • You can either drag your file to the Drop files here area in the middle of the Files page (see #1 below), or click the Upload button (see #2 below).
    • If you clicked the Upload button, locate your document in the File Upload window. When you find the file, click Open or double click on the file.

      Screenshot 2023 06 20 at 12.57.22 PM

    • Click OK when asked if you want to overwrite the file with the same name that already exists:

      DOCman: Overwrite Existing File

    • Your document should now be updated with the new file.

    2. Updating a Document with a New File of a Different Name

    You may need to replace a DOCman document with a file of a different name.  The process is similar to the above, but with a few extra steps.

    • Click on the "Components" menu, and select "DocMan > Documents"

      Screenshot 2023 06 06 at 2.44.02 PM

    • Click the title of the document you wish to update to open it
    • You can either drag your file to the "Drop another file to update area" (see #1 below), or click the Update button (see #2 below).
    • If you clicked the Update button, locate your document in the File Upload window. When you find the file, click Open.
    • Click the Save & Closebutton at the top (see #3 below).

      Update DOCman document with new file of different name

    • Your document should now be updated with the new file.
  • Uploading and Publishing Documents using DOCman (Joomla! 4/5)

    This procedure explains how to upload, publish, and unpublish documents using the DOCman document manager component on Joomla! 3.x web sites.


    1.  Uploading a new document

    • Click on the "Components" menu, and select "DOCman > Documents"

      Screenshot 2023 06 06 at 2.44.02 PM

    • Click the "New" button to the upper left: Screenshot 2023 06 06 at 3.05.23 PM
    • You can either drag your file to the Drop a file here area (see #1 below), or click the Upload button (see #2 below).
    • If you clicked the Upload button, locate your document in the File Upload window. When you find the file, click Open.
    • When the document has been uploaded, the filename will appear above the text "Drop another file to update".
    • If you want to rename the document for DOCman, change the text in the Title field (see #3 below).
    • Select the appropriate category from the Category dropdown (see #4 below).
    • Click the Save & Closebutton at the top (see #5 below).

      Screenshot 2023 06 06 at 3.13.07 PM

    2. Unpublishing and Re-Publishing a Document

    You can unpublish a document without deleting it from your web site.

    • In the Administrator interface, select "Component > DocMan > Documents"
    • Click the check box to the left of your document's name (see #1 below).
    • Click the Unpublish button above the list of documents (see #2 below).
    • The Status column should display Unpublished, indicating that your document will no longer be accessible from the web site.
    • To publish it again, click the check box to the left of your document's name.
    • Click the Publish button above the list of documents (see #3 below).

      DOCman: unpublishing and publishing documents

     

    3.  Uploading and Publishing from the Front-End

    You can upload and publish files from the front-end if all of the following conditions exist:

    1. You belong to a group that has access to edit at least one Joomla! category
    2. You belong to a DOCman group with front-end access to Upload, Approve, Publish and Maintain
    3. DOCman is accessible from the front-end

    To upload and publish your documents from the front-end:

    • Log into the front-end of your web site
    • Browse to DOCman via the front-end
    • Click the Add document link above the list of documents and folders.
    • Follow the steps for Uploading a new document above.


     

  • Uploading Multiple Files using DocMan (Joomla! 4/5)

    This document explains how to upload multiple files simultaneously using the DOCman document manager component for Joomla!.


    Uploading Multiple Files

    • Log into your Joomla! site administrator URL.
    • Click on the "Components" menu, and select "DocMan > Documents"
    • Click the "Upload" icon" above the list of files: DOCman upload button
    • Drag your files to the "Drop files here" area of the popup window that appears:

      DOCman: Drop files here

    • Select the appropriate category from the Category dropdown (see #1 below).
    • If you want to rename the documents within DOCman, change the text in the Title fields (see #2 below).
    • Click Save to the upper left (see #3 below):

      Screenshot 2023 06 15 at 11.30.47 AM

    • Click the word "here" near the top in the green message "Documents have been successfully created. Click here to close the uploader" to exit the document uploader window:

      DOCman: Closing the document uploader