Login

Learning & Support

Documentation

Working with Collections

Twixl Support Team Updated: - Created :

    1. Organizing your content in 'collections'

    Collections organize the content in your app as you can upload content items (and aliases, links, web content) directly in them. Especially when your app naturally becomes filled with more content, having all of your content items in the Root Collection becomes cluttered fast. So it is a good thing to think about your app structure and using collections from the beginning.  

    Here are some use cases for collections:

    • Create a collection with your articles for the day / the week (more or less like a traditional issue).
    • Divide your content into different sections, each their own collection, so browse pages can then allow you to go a level deeper to another browse page for a particular section.
    • Publish a catalog with each chapter (or sub-chapter) represented by one or more collections.

    A Twixl app will always start with one initial browse page when the app starts, that will be based on the 'root collection'. The Root Collection always has to be present and cannot be deleted. Therefore, the Root Collection is a special kind of collection.

    2. Creating a collection

    • Select 'Collections' in the left menu bar.
    • Click on "+" next to the 'Collections' title.

    Different sections:

    1. Name: This is a required field and needs to be unique as it will define your collection throughout the project.
    2. Title: The title will be shown to the end user and needs to be clear for them.
    3. Collection type: There are 2 types of collections:
      Free of charge: One doesn't need to purchase these collections nor has to have a running subscription. However, you can still add an entitlement request if you want to hide your content for non-entitled users.
      Purchase: Here the paywall will be called if the user hasn't bought this collection already.

    If your app has metered access enabled, you can also select a 'preview' type here. Preview allows you to attract your reader to buy a magazine by offering them some free content. Read  more about metered access here.

    1. Publish date: If you have subscriptions in your app, the publish date will determine whether a collection is included in the subscription of the reader or not.
    2. Product identifier: Use the presented identifier in your store or copy the one from the store here so purchases can be identified.
    3. Open in: There are 2 modes as to how a collection will open:
      Browse mode: Will show the content items of that collection by their thumbnails in a grid so the user can browse through the items and select the ones they want to read.
      Detail mode: Will open the first content item in the list directly and the user needs to swipe to the next content item to continue reading.
    4. Sort mode: Different modes are available here and these will define the order the content items will be displayed for the user both in browse and detail mode. By selecting 'Manual' you can manually change the order of the content items in the list using drag and drop.
    5. Grid style: Select the grid style you want to use for a collection that will be opened in browse mode. Leave to 'Default' when your collection is in detail mode.
    6. Default item style: When adding your content items to the collection, you will be able to select an item style for each of your content items. By selecting a default item style here, this item style will be presented as the default that can be changed if needed. You can select 'default' when your collection is in detail mode.
    7. Collection options: You can enable 2 special options for each collection:
      Monolithic Download: Downloads all of the content items in the collection at once so the user can read this offline too. This takes up space on the user's device however, so something to take into account. A user can always download  a complete collection by long pressing its thumbnail in the browse grid.
      Requires entitlement: If Entitlement is enabled for your project, you can offer the content in your collection to a selected audience via a login entitlement pop-up.
    8. Advanced scripting (optional): If you have the optional advanced scripting mode enabled in your account, this allows you to filter specific content based on certain criteria. More details here.

    You can also add a thumbnail to identify your collection on the platform or to use it in a collection link. If left empty, Twixl will use the thumbnail of the first content item.

    When you are ready with the collection settings you can either 'Save' or 'Save and add content item' which will allow to immediately upload content items to your new collection.

    All collections can be offered as In-App Purchases (except for the Root Collection). In that case, make sure your product identifier matches the one in App Store Connect Connect and/or Google Play.

    3. Uploading content to your collection

    1. Add content items to your collection by clicking '+' next to your Collection Content title.
    2. You can also immediately create another collection and link to this one via this option.
    3. Once your content item is uploaded to the collection, it will appear in the Recently Updated list. This makes it easy if you still want to change settings or metadata in your content items. The most recently updated content items are shown first so you don't have to search in your list of content items if they are sorted differently.
    4. The sort order of your content items, i.e. how they will be presented to the end user, is shown in  Collection Content.
    5. Need to change anything in the settings of your collection? Then click on 'Collection Settings'.

    4. Setting the 'root collection'

    When you are in the 'root collection', and you edit the settings, there is the option to change which collection is used for the 'root'.

    If you decide you want to change the collection that is used as the 'root', you'll get an extra warning explaining the consequences. The collection you select will be renamed to 'Root'. The former root collection will be renamed to 'Root - Before dd/mm/yyyy'.

    Was this article helpful?

    0 out of 0 found this helpful