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 Can I use the calendar as a personal diary and keep my entries private?
Answer Yes. When adding an event to the calendar, you can choose to make it public or private. Private events are generally used when someone wants to use the calendar system as a diary.
Question How can I set up reminders for events?
Answer When adding or editing an event, you can enable reminders for yourself and specific user groups. You can also choose how much notice you want for each reminder.

Members can subscribe for reminders on an individual event screen. They can also personalize their reminder settings, including removing reminders or having multiple reminders at different times.

Members can also subscribe for notifications to specific event types to be notified whenever events under those types are scheduled.
Question How can I schedule Commandr commands to run automatically?
Answer To schedule commands, create an event with the "System command" event type. This option needs to be enabled in the configuration first. In the event details, you can specify either a URL for Composr to call or a snippet of Commandr code to execute. Be sure to disable the WYSIWYG editor for this type of event. You'll also need to have the system scheduler configured for the commands to run automatically.
Question Can I add external feeds to the calendar?
Answer Yes, you can add RSS or Atom feeds to your calendar. This lets you view time-based information from external sources alongside your calendar events.
Question What do I do if a recurring event needs to be changed or skipped?
Answer Composr has a "fixing an event" feature to handle changes to recurring events. This is useful if an event needs to be cancelled or rescheduled. You edit the event as if it were a new, standalone event and choose the "Edit with fixing past recurrences" option. This separates the past occurrences from the modified event, ensuring future recurrences reflect the changes.
Question What is the "recurrence pattern" and how does it work?
Answer The recurrence pattern is a powerful tool that defines how often an event repeats. While it might seem complex at first, it provides a lot of flexibility. Think of it as a binary code where each digit represents a time period (like a day or week). A "1" indicates the event occurs, and a "0" means it doesn't. This lets you create complex schedules like "every weekday" (daily with pattern 1111100 if it starts on a Monday) or "every other Tuesday" (weekly on Tuesday with the pattern 10).
Question What are the different views available in the calendar?
Answer The calendar has five views:
  • Year view: Displays an overview of the entire year.
  • Month view: Shows events within a specific month.
  • Week view: Displays events for a selected week.
  • Day view: Shows events scheduled for a specific day.
  • Event view: Displays the details of a single event.

You can easily navigate between these views to get different levels of detail and focus on specific periods or events.
Question How do I add events to the calendar?
Answer You can add events in several ways:
  • Through the Admin Zone or Content Management Zone: Go to Admin Zone > Content > Calendar.
  • Directly on the calendar: Click on a date box on the calendar view.
  • Using the "Add Event" button on any calendar view.

Deleting events can be done at the bottom of the event's edit form. You have options for recurring events, such as editing/deleting the specific occurrence, editing/deleting future ones, or all of them.
Question How do I categorize events?
Answer You categorize events using "Event types". Composr provides default types like "Anniversary", "Appointment", "Birthday", "General", "Public Holiday", "Task", "Vacation", and the special "System command" for executing Commandr commands. You can also add your own custom event types to suit your specific needs, such as "Appraisal Session" for a business website.
Question What is an "event" in the Composr calendar system?
Answer An event is any entry in the calendar. Importantly, an event isn't limited to a single point or range in time. Events can recur based on a schedule you define. This makes them very flexible – they can represent anything from one-time appointments to recurring birthdays or even weekly team practices.