Featured Sites: A-Z Index

H


Newest 10 Entries

Question What are some of the default endpoints available in the server-side API?
Answer Default endpoints cover various functionalities, including:
  • Account: join, login, lost_password, setup_push_notifications
  • Misc: contact_us
  • Content: commandr_fs

Specific details on parameters and response data for each endpoint can be found in the documentation.
Question How does authentication work with the server-side API?
Answer Authentication is handled automatically using cookies, similar to regular website requests. If cookies are not feasible, the response parameters device_auth_member_id_cn/device_auth_pass_hashed_cn/device_auth_member_id_vl/device_auth_pass_hashed_vl from the login endpoint can be resent as POST parameters in subsequent requests.
Question How do I access the server-side API for my mobile app?
Answer The server-side API can be accessed via HTTP calls to http://yourbaseurl/data/endpoint.php. Results are returned in JSON format. The API utilizes endpoints with a 'hook' name and a 'hook type' categorization. Both REST-style and GET-parameter style requests are supported, with the latter recommended for simplicity.
Question What is the purpose of the Composr Mobile SDK Toolkit?
Answer The Toolkit, part of the composr_mobile_sdk addon, aids in mirroring Composr website resources into a mobile app. It includes tools for generating iOS/Android string resources from language files and exporting theme images in a directory structure suitable for iOS/Android app image assets.
Question How can I obtain Composr Mobile SDK?
Answer The iOS/Android SDK can be found on GitLab at: Composr ecosystem / Composr Mobile SDK · GitLab.

To connect to a Composr site, you will need to install the composr_mobile_sdk addon, which is not bundled. This addon provides scripting to generate app assets from the Composr site.
Question What is Composr Mobile SDK?
Answer Composr Mobile SDK (CMS SDK) is a toolkit designed for experienced iOS and Android developers to build mobile apps that integrate with a Composr-powered website. It offers both Composr-specific integrations and a collection of standalone utilities for building apps, providing a common base between iOS and Android akin to the PHP and Composr APIs, enabling easier code porting while maintaining a native experience.
Question What is the Composr maintenance policy?
Answer Composr follows a rolling release model. This means:
  • New major/minor versions are released as they are ready.
  • Patch releases, primarily containing bug fixes, are only released for the latest supported major/minor version branch.
Users are responsible for staying updated to the latest release or applying necessary hotfixes.

This policy allows developers to focus resources on the latest versions and encourages users to leverage the ongoing improvements. You can find the release status on the Composr maintenance status page.
Question What are the general courtesy guidelines for interacting with the Composr community?
Answer
  • Understand that Composr is developed and maintained by volunteers who dedicate their time to the project.
  • Refrain from demanding free support or expecting developers to work on specific schedules.
  • Avoid placing undue pressure on volunteers or pushing them beyond their capacity.
  • Approach the community with respect and a collaborative spirit.
  • Remember that offering financial sponsorship for desired features can accelerate development.
Question How can I provide design feedback for Composr?
Answer Constructive design feedback is valuable. To provide effective feedback:
  • Be specific and detailed. Identify particular issues and provide clear examples.
  • Offer solutions. Suggest improvements or provide mockups demonstrating your ideas.
  • Avoid vague statements. General comments like "it looks dated" are unhelpful.
  • Understand design constraints. Consider factors like modularity, generality, feature density, compatibility, performance, and the subjective nature of design.
Directly reporting specific design bugs to the tracker or redesigning Composr interfaces yourself are excellent ways to contribute.
Question How do I make a feature suggestion for Composr?
Answer You can suggest features through the tracker or the Report Issue Wizard. When making a suggestion:
  • Be comprehensive and self-contained. Provide all necessary information and context for the developers to understand your suggestion.
  • Focus on widely beneficial features. Esoteric suggestions are less likely to be implemented.
  • Understand developer constraints. Feature development depends on factors like developer availability, funding, and project strategy.
  • Consider sponsoring features. Financial contributions can prioritize the development of desired features as it affords developers the time to implement it.

Top 10 Entries

Question How can I communicate privately with other members?
Answer Conversr offers two ways to have private conversations:
  • Private Topics:
    • Start a private topic from a member's profile, by clicking "Whisper" on their post and selecting "Quote post to a new Private Topic with this member," or from your account by selecting "Start a Private Topic" and entering the desired username.
    • Participate in the topic just like a regular forum topic.
    • You will receive notifications for new posts in your private topics.
    • Topics can be moved to the "Trash" category or other categories of your choosing for organization.
  • Inline Personal Posts (Whispers):
    • Send a private message within a public topic by clicking "Whisper" on a post and selecting "In-topic personal post to this member."
    • Whispers are visible only to the sender and recipient, and the whispered post is highlighted.
    • Receive notifications for new whispers.
Question What are some key considerations when choosing field types for my catalogue?
Answer When selecting field types, consider:
  • Data type: Choose the appropriate field type for the data you want to collect (text, numbers, dates, etc.).
  • Comcode support: If you need rich text formatting or translation support, opt for fields that support Comcode.
  • Validation: Some field types offer built-in validation to ensure data accuracy.
  • Privacy implications: Be mindful of the sensitivity of the information and whether it requires specific privacy considerations.
Question How can I ensure the privacy of personal information stored in my catalogues?
Answer Composr's privacy system can help manage personal data within catalogues. To leverage it:
  • Use specific field types: Utilize dedicated field types for sensitive data like member IDs, usernames, emails, IP addresses, and passwords for efficient handling by the privacy system.
  • Enable "May contain personal information": Mark fields that may contain personal information, enabling the privacy system to identify and handle such data during purging or downloading.
Question What are some specialized types of catalogues available in Composr?
Answer Composr supports specialized catalogues, including:
  • eCommerce catalogues: Integrate with the Composr shopping cart for online stores.
  • Classified ads: Offer features like archival categories and usergroup-specific advert durations.
Question How are breadcrumbs handled in catalogue views?
Answer Catalogue breadcrumbs can be customized using XML code (Admin Zone > Structure > Configure breadcrumb overrides). By default, they include the list of catalogues. However, Composr provides default breadcrumb XML that removes this, focusing on the current category hierarchy. Tree catalogues omit the index link, while non-tree catalogues include it.
Question What is a tree catalogue and how do I create one quickly?
Answer A tree catalogue has a hierarchical category structure (which can contain sub-categories), similar to the download system. Composr offers a special feature for creating tree catalogues by simply typing the desired categories in a specific format (which is explained and available when adding a new catalogue), which automatically generates the tree structure.

Alternatively, a non-tree catalogue is simpler and only has top-level categories.
Question Can I customize the look and feel of my catalogue?
Answer Yes, Composr allows advanced users to customize catalogue appearance through Tempcode programming. This involves using template IF directives to apply specific styles based on the catalogue's name and manipulating template parameters for complex layouts. Alternatively, you can create new template files using the catalogue name in the file to specify complete templates for specific catalogues. Check out the tutorials for more information.
Question What are the different display types for catalogue entries?
Answer Composr provides four main display types for catalogue entries:
  • Title lists: Simple lists of entry titles linking to the full entry page.
  • Field-maps: Highly flexible, displaying as many fields as you desire within the category view.
  • Tabular listings: Organizes entries into columns, suitable for short data fields.
  • Grids of images: Displays entries as a grid of images, ideal for visual catalogues.

It is possible to create your own templates including ones that are specific to a catalogue. Check out the catalogues tutorial for more information.
Question Why might I need a programmer for my catalogue?
Answer While Composr catalogues offer great flexibility, they can become complex if you need sophisticated data relationships, efficient searching, high data reliability, or advanced customization. In these cases, a programmer's expertise in database design, normalization, and templating can be invaluable.
Question What are catalogues in Composr?
Answer Catalogues are custom databases you can create within your Composr website. They allow you to define your own records with custom fields and organize them into categories. Think of them as powerful tools for managing various types of content, like a database of books, a directory of businesses, or even a classified ads system.