QuickTemplates v2 - Plugin

Version 24

    Summary

    A plugin to facilitate fast and effortless ways for Users to create content templates.  Lowers barriers to content contribution.

     

    Official plugin of  The specified item was not found.

     

    Installation

    Plugin install through Admin Console, with optional configurations.

    See Configurations section (below) for more information.

     

    Releases

    • 2.0.0.0 - December 10th, 2012 (Jive 6)

     

    Plugin Support

    This plugin IS NOT supported by Jive, and use of this plugin should be done at the user's discretion, or as advised by their Jive Support representative.

     

    Copyright and License

    Copyright 2013 Ryan Rutan under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    UPDATE

    For information about availability for this plugin in Jive 7, please see the following announcement:

    The specified item was not found.

    Features

     

    • Quickly copy subject, body, categories, and tags from any Document* , Discussion**, and/or Blog Post (see Screenshots, below) to create another Document, Discussion, or Blog Post.  Interchanging above content-types supported!
      • Copy process is performed without persisting content to the system.  This means no more residual pieces of content when users decide they want to abandon copy mid-way!!!!
      • * Does not support Uploaded Files (a.k.a. Binary Documents)
      • ** Only supports copying subject, body, categories/tags from the root message of a Discussion from the Copy Dialog.  If template functionality is used and the content type is set to a specific message in a discussion, then that is supported, but again only for that single message.
    • URL Parameters for Content Seeding for Document, Discussion, and Blog Post Content-Types
      • Fields include:  subject, body, categories, and tags
        • Note: For discussion: Discussions also has the question field available to default discussion as question.
      • Allows for users to create Documents/Discussion/Blog Posts from ANY Jive Content Type that is considered a JiveContentObject

     

    Plugin Usage

    I've created this quick video demonstrating the Quick Templates v2 Plugin, hope this helps explain how it can be used.

     

    Template Parameter Details

    The following is a list of parameters that can be passed into the out-of-the-box create content screens for documents, discussions, and blog posts.

    • /document/create.jspa
    • /discussion/create.jspa
    • /blog/create-post.jspa

     

    Parameter
    Usage

    tid

    ttype

     

    *Required Together

    These two parameters are required together; however optional when not used at all.  They tell Jive to seed the subject, body, categories and tags from a specific piece of content, such as a Document, Discussion, Blog Posts, Idea, or any valid JiveContentObject

     

    Examples for ttype include:

    • 102 = Document
    • 1 = Discussion
    • 38 = Blog Post
    • 602 = Project Task
    • 3227383 = Idea
    • ...

    containerID

    containerType

     

    *Required Together

    These two parameters are required together; however optional when not used at all.  They tell Jive to default the destination for the new piece of content.

    subject

    (optional)

    When set, this parameter will override the subject of a new piece of content.  In the event you want to create a new subject that stems of a template, you can use the _SUBJECT_ marker in this parameter.

     

    For example:  If you are using a Template with a subject Foo ... and you want to prefix your title with Copy of you would simply pass in the value Copy of _SUBJECT_ into this parameter.  See use-cases below for more details.

    body

    (optional)

    When set, this parameter will override the body of a new piece of content.  Format for this parameter is a well-formed HTML string, preferably prefixed and suffixed with <body> and </body> respectively.  In the event mal-formed HTML is passed into this parameter, the editor will try to correct; however, it's ability to recover is not supported.

     

    Note:  It is recommended that if you plan to use this parameter, you perform an HTTP POST rather than a GET to reduce body manipulations.  While not mandatory, it is recommended for larger bodies.

    categories

    (optional)

    When set, this parameter will add categories to the specific piece of content. If used in conjunction with a template, it will add additional categories.

     

    Note:  When using multiple categories, you must send over multiple values (or submit the values in array form).

    For example: &categories=1001&categories=1002  NOT &categories=1001,1002

    See use-cases below for more details.

    tags

    (optional)

    When set, this parameter will add tags to the specific piece of content. If used in conjunction with a template, it will add additional categories.

     

    Note:  When using multiple tags, you must send over multiple values (or submit the values in array form).

    For example:  &tags=test&tags=demo  NOT &tags=test,demo

    See use-cases below for more details.

    question

    (optional)

    For discussions only, if set this will override the defaults from a template or the system preferences.  If left undefined, preference will be given to the template (if available) and then system rules.

    Value :  (true)

     

    Template Parameter Use-Cases

    In this section, I'll show you some example links that you can use/construct to leverage some of the hidden features in this plugin.   These links can be embedded into a simple HTML or Formatted Text Widget for quick navigation to these pieces of content.  For those that have the Managed Snippets Plugin installed, they can create a virtual Shared Template implementation and single-source manage it via that plugin.


    The following are the fields for the  Foo Document Template for these use-cases, HTTP POST recommended:

    • id = 1234
    • contentType = 102
    • subject = Foo
    • body = <body><p><strong>Hello World</strong></p></body>
    • tags = test1, test2
    • categories = cat1 [id=1000], cat2 [id=1001]
      • Note: Container has 2 additional categories:  cat3 [id=1002] and cat4 [id=1003]

    • Create a new piece of content from the Foo Document Template
      • ?tid=1234&ttype=102
    • Create a new piece of content in Group[id=7890], Space[id=7890], or Project[id=7890] from the Foo Document Template
      • ?tid=1234&ttype=102&containerID=7980&containerType=700
      • ?tid=1234&ttype=102&containerID=7980&containerType=14
      • ?tid=1234&ttype=102&containerID=7980&containerType=600
    • Create a new piece of content in a Group [id=7890] with a new subject from the Foo Document Template
      • ?tid=1234&ttype=102&containerID=7980&containerType=700&subject=New%20Topic
        • Create a piece of content with the Subject => "New Topic"
      • ?tid=1234&ttype=102&containerID=7980&containerType=700&subject=New%20Topic%20-%20_SUBJECT_
        • Create a piece of content with the Subject => "New Topic - Foo"
    • Create a new piece of content in a Group [id=7890] with Tags from the Foo Document Template
      • ?tid=1234&ttype=102&containerID=7980&containerType=700
        • Create a piece of content with the Tags => "test1 test2"
      • ?tid=1234&ttype=102&containerID=7980&containerType=700&tags=test3&tags=test4
        • Create a piece of content with the Tags => "test1 test2 test3 test4"
    • Create a new piece of content in a Group [id=7890] with Categories from the Foo Document Template
      • ?tid=1234&ttype=102&containerID=7980&containerType=700
        • Create a piece of content with the Categories => "cat1 cat2"
      • ?tid=1234&ttype=102&containerID=7980&containerType=700&categories=1002&categories=1003
        • Create a piece of content with the Categories => "cat1 cat2 cat3 cat4"
    • Create a new Question in a Group [id=7890] with Categories from the Foo Document Template
      • /discussion/create.jspa?tid=1234&ttype=102&containerID=7980&containerType=700&question=1
        • Create a piece of content with the Categories => "cat1 cat2"
    • Create a new piece of content in a Group [id=7890] from scratch
      • ?containerID=7980&containerType=700&subject=New%20Subject&body=<body><p>Hello</p></body>&categories=1001&categories=1002&tags=test8&tags=test9
        • Create a piece of content with Subject [New Subject], Body [Hello], Tags [test8, test9] & Categories [cat2, cat3]

     

    Note:  Each of the above examples assumes that you use one of the pre-determined content-types and their corresponding URL prefix:

    • Blog Post = /blog/create-post.jspa
    • Discussion = /discussion/create.jspa
    • Document = /document/create.jspa

     

    Screenshots

     

    Screen Shot 2012-12-10 at 12.06.25 PM.png

    Note:  Added "Copy" Action Item for BlogPosts, Discussions, Documents

    Screen Shot 2012-12-10 at 12.07.29 PM.png

    Note:  Streamlined copy menu for quick-access to all support content-types

     

     

    Known Issues / Disclosures

     

    Issues

    None

     

    In the previous version of the QuickTemplates - Plugin, there was a known issue that I called "Category Ghosting".  I am happy to say that due to the nature of the changes in Jive 6, this issue is no longer an issue!

     

    Disclosures

    This plugin overlays (alters) the Create Document, Discussion, and Blog Post actions in Jive to achieve its functionality.  While the design for this overlay is elegant and well thought out, users are asked to test these use-cases and insure expected results both with and without the use of template parameters.