JBoss.orgCommunity Documentation

Add a document

There are several types of document in eXo Platform, such as File, Article, Podcast, Sample node, File Plan, Kofax, and more.

The table below shows types of nodes which can be added to various document types. The rows indicate which nodes in the left column can be added. The columns indicate which nodes at the top can contain.

 FileArticlePodcastSample nodeFile PlanKofax documentContent folderDocument folder
File
Article       
Podcast
Sample node       
File Plan    
Kofax  
Uploaded file
Content folder    
Document folder    

Note

green tick indicates that the corresponding document can be added into. A blank entry means that the corresponding document cannot be added into.

Following the horizontal, you will know which nodes can be added.

Following the vertical, you will know which node can be included.

Add a new document

  1. Select a folder from the left pane where you want to add a new document.

  2. Click [ Add Document ] on the Action bar to open a list of content templates.

  3. Click your desired template. See more details in Step 3 of the Add content section.

    Each document (except Article) must be added to categories when being created.

Attach files to a document

  1. Select a document or a folder that you want to attach files, and click [ Upload ] on the Action bar.

    The Upload File form will appear.

  2. Enter a name into the Name field. If not, the Name field is automatically filled with the file name.

  3. Click Browse... to select the attachment file. You can click plus to add more files.

  4. Click Save to attach the files.

    To view the attached file directly in Sites Explorer, simply click its name.

    Note

    eXo Platform enables you to view all types of documents, such as Open Office, Microsoft Office in the PDF format.

Create a new File document

  1. Follow the steps in the Add a new document section to open the corresponding form to add a File document.

  2. Input a name for the file document in the Name field. Some special characters (@ # % & * ( ) “ ' : ; [ ] {} / !) cannot be used in the Name field.

  3. Click the Mime Type field and select one type. There are three types of File document:

    • text/html: when creating a text/html File document, you can input values like source code (HyperText Markup Language HTML) in the Content field . After being created, it will generate the content you want, then you can see both the input source code and the generated content in that document.

    • text/plain: after a text/plain File document is created, it will display exactly what you input in the Content field.

    • application/x-groovy+html: it indicates your file as a groovy file.

  4. Input a value in the Content field:

    • text/html or application/x-groovy+html: if you want to create a File document with a source code and generated content, click the [ Source ] button in the Editor bar.

    • text/plain: if you select text/plain type, the content field will be displayed like the following illustration.

  5. Optionally, fill values in all the rest fields, including Title, Description, Creator and Source.

    Click plus to open more fields.

  6. Click Save or Save & Close to accept creating a new file document.

    After being created successfully, a file document with the text/html type will be displayed like the illustration below.

Create a new article

  1. Follow the steps in the Add a new document section to open the corresponding form to add a new Article document.

  2. Input name and title of the Article in the Name and Title fields. Special characters (@ # % & * ( ) " ' : ; [ ] {} / !) are not allowed in the Name field.

  3. Input values for both fields: Summary and Content.

  4. Click Save or Save & Close to accept the inputted values.

After being created, your newly added Article document will be shown as below.

The Links area lists all its related documents. After adding relations to a document, Article will be displayed. You can click these links to view the content of the related documents. For more details about how to add a relation to a document, refer to the Add a relation section.

The Attachments area lists all its uploaded files/documents which are attached with the Article. You can remove the attachments by clicking trash can.

For more details about how to add an attachment, see the Attach files to a document section.

Note

The name of document may be as the same to that of the existing one. When a new document is created with the same name as other existing document, a numeric index will be added to the name (for example, test [2]).

Create a new Podcast

  1. Follow the steps in the Add a new document section to open the corresponding Podcast form.

    Details:

    FieldDescription
    NameThe document name which is required. Special characters (@ # % & * ( ) “ ' : ; [ ] {} / !) are not allowed in the Name field.
    CategoriesCategories of a document.
    TitleThe display name of a document.
    LinkThe link to the source path of the uploaded media file that is required.
    AuthorThe author of the uploaded media file.
    Explicit

    It is used to indicate if your Podcast episodes contain an explicit content or not.

    CategoryThe category of the uploaded media file, for example music, film, or short clip.
    KeywordThis field allows you to search your Podcast files more quickly. You can use commas to separate between keywords.
    Publish DateThe date when an episode was released.
    DescriptionInformation about the uploaded media file.
    Mime TypeThe type of the uploaded media file.
    LengthThe length of the uploaded media file.

  2. Input values for fields. To upload a media file, click Browse... and select the media file from your device.

  3. Click Save or Save & Close to finish.

Once being created, a Podcast will be displayed.

Create a new Sample node

  1. Follow the steps in the Add a new document section to open the Sample node form.

  2. Complete the appropriate fields.

  3. Click Browse... to locate your desired image, and upload it.

  4. Click Save or Save & Close to finish.

After being created, a new sample node will be displayed.

The Relations area is used to list all its related documents. See the View a relation section.

You can click the links to view content of the related document.

The Attachments area is used to list all its uploaded files. See the Attach files to a document section for more details.

Create a new File Plan

  1. Follow the instructions in the Add a new document section to open the corresponding form to add a File Plan document.

    Details:

  2. Fill in the appropriate fields of the tabs in the form.

  3. Click Save or Save & Close to finish.

Create a new Kofax document

  1. Follow the instructions in the Add a new document section to open the Add Kofax Document form.

  2. Input a name for a Kofax document in the Name field which is required. Special characters (@ # % & * ( ) “ ' : ; [ ] { } / !) are not allowed in this field.

  3. Select categories for a Kofax document by clicking plus.

  4. Click Save or Save & Close to finish.

After being created, a Kofax document will be displayed.

Create a new event

  1. Follow the instructions in the Add a new document section to open the Add an event document form.

  2. Enter a title for the event.

  3. Input the location where the event will take place in the Location field. Select the Google Maps checkbox if you want the location of the event to be shown on Google Maps.

  4. Enter the Start and End Date/Time of the event.

  5. Fill the Summary and Content fields.

  6. Click Save or Save & Close to finish.

After being created, the event will be displayed like the illustration bellow.

Create an accessible media

  1. Follow the instructions in the Add a new document section to open the content template list, and select the Accessible Media template.

    Details:

    FieldDescription
    NameThe document name which is required. Special characters (@ # % & * ( ) “ ' : ; [ ] {} / !) are not allowed in the Name field.
    CategoriesThe name of the selected categories.
    LanguageThe language of the media.
    ContentThe content of the media which is required.
    TitleThe display name of the media.
    CreatorThe creator of the media.
    SourceThe source of the media.
    CaptionsProvide the text of the dialogue and important sounds.
    Audio descriptionProvide the narrate track of the media. You can browse and upload another media file from your local device to set it as the audio description.
    Alternative textProvide the descriptive information about the media.

  2. Input the information in the fields, and attach existing files from your local device to the following fields:

  3. Click Save or Save & Close to finish.

The accessible media can be played right after being created.

Details:

Button Function
Stop the media.
Play the media. After clicking this button, will become and vice versa.
Play the previous media.
Play the next media.
Listen to the audio description. This icon only appears if you attach another media with the audio description to the Audio description field. After opening the audio description, to back to the original media, click .
Activate/Deactivate the media caption. If you attach an .srt or .xml file to the Captions field, the caption will appear when you clicking this button.

Note

You can also attach Captions and Audio description to the uploaded media when editing this document. To know how to upload a file, see the Attach files to a document section.