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 What are redirects and how can I use them for subsites?
Answer Redirects let you create custom URL paths that point to different zones and pages within your site.

Examples:
  • Sharing modules across zones: Create a redirect to make a module in one zone appear in another.
  • Creating shortcuts: Use a redirect to point a short URL to a longer, more complex URL.
  • Moving pages: Use a redirect to ensure old links still work after moving a page to a new location.

Go to Admin Zone > Structure > Redirects.
Question What are virtual roots and how do I use them?
Answer Virtual roots let you make a sub-category within a Composr module (e.g., downloads) appear as the top-level category. This is useful for creating separate "databases" of content for different subcommunities.

To create a virtual root:
  • Enable "Virtual root links" in the Admin Zone > Setup > Configuration > Feature options > Advanced.
  • Navigate to the desired category while logged in as staff.
  • Click the rightmost link in the breadcrumbs (it will be an anchor for virtual root creation).
  • Use the resulting URL in your menus to link to the "virtualized" category.
Question Can I have subsites and subcommunities within a single Composr installation?
Answer Yes, Composr offers various tools to create subsites and subcommunities within a single installation:
  • Zones: Create separate sections under different URLs with their own pages and content.
  • Redirects: Make modules appear in different zones without actually moving them.
  • Categories & Virtual Roots: Organize content like galleries, downloads, and catalogs into sub-trees that appear as separate entities.
  • Usergroups & Permissions: Group members into subcommunities and control their access to specific content.
  • Themes: Customize the look of different zones.
Question What is the difference between a central site and a satellite site in an M.S.N.?
Answer The central site hosts the shared forum, member database, and netlink system. It is the core of your M.S.N.

Satellite sites are the additional websites within your network. They connect to the central site for member information and forum access.
Question What are the advantages and disadvantages of using an M.S.N.?
Answer Advantages:
  • Full control: You have complete control over each site's settings and content.
  • Administrative separation: Managing staff and content for each site is more organized.
  • Special M.S.N. features: Composr provides specific features like the 'netlink' system for easy navigation between network sites.

Disadvantages:
  • Configuration and maintenance: Setting up and maintaining multiple sites can be more complex.
Question What is a multi-site network (M.S.N.) in Composr?
Answer An M.S.N. allows you to run multiple Composr websites (installations) that share a common forum and member database. It's ideal for website networks with shared communities but segmented content, staff, or branding. In essence, members who join one site automatically have accounts on all sites within the network.
Question What are the key classes and utilities provided by Composr Mobile SDK?
Answer CMS SDK provides several classes with utility functions mirroring PHP and Composr APIs, including:
  • CMS_Arrays: Array operations (e.g., implode, explode, list_to_map).
  • CMS_Strings: String manipulation (e.g., strip_tags, html_entity_decode, strpos).
  • CMS_Langs: Localization functions (e.g., do_lang).
  • CMS_Preferences: User preference management.
  • CMS_Timestamps: Timestamp functions (e.g., get_timezoned_date_time, time).
  • CMS_HTTP: Web service interactions (e.g., rawurlencode, json_decode, http_get_contents).
  • CMS_Users: User data and permission checks (e.g., has_page_access, is_staff).
  • CMS_Flow: App flow control (e.g., access_denied, attach_message).
  • CMS_Forms: Form building and management.
  • CMS_Database: SQLite database access and manipulation.
  • CMS_Notification: Push notification handling.
  • CMSNetworkManager: Network request execution and response handling.
Question How do I set up Composr Mobile SDK in my iOS and Android projects?
Answer iOS (Xcode):
  • Create a new project or open an existing one.
  • Add a Prefix Header file (.pch) if you don't have one, following the provided instructions.
  • Add required frameworks to your project's Build Phases.
  • Add the CMS SDK to your project, then remove references to unwanted files.
  • Set the header search path to the CMS SDK folder in build settings.
  • Add a compiler option for the JsonKit library.
  • Import CMS_SDK.h in your .pch file.

Android (Eclipse):
  • Create a new project or open an existing one.
  • Import CMS SDK into your workspace as an Android project.
  • Ensure "Is Library" is checked in the CMS SDK's "Android" properties tab.
  • Add CMS SDK as a dependent library in your project's properties.
  • Clean and rebuild your project.
Question What are some key concepts related to mobile app development with Composr?
Answer Essential concepts include:
  • SDK (Software Development Kit): An API implementation, typically as a library.
  • API (Application Programming Interface): A set of rules for software interaction.
  • JSON (JavaScript Object Notation): A common language for structured data transfer over REST.
  • REST (Representational State Transfer): An architectural style for web services.
  • Push notification: A notification sent to a mobile device.
Question What other approaches exist for mobile integration with Composr?
Answer Other approaches, in various stages of development, include:
  • Tapatalk: A third-party forum app with an official Composr addon, offering a high-quality "out-of-the-box" Composr app experience.
  • Further Composr Mobile SDK development: Plans and issues relating to the SDK's evolution can be found on the Composr tracker, driven by commercial projects and feature sponsorship.