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 contribute to translating Composr?
Answer You can contribute to Composr's internationalization by:
  • Joining the translation team on Transifex: Translate language strings collaboratively with other volunteers.
  • Becoming a language maintainer: Take responsibility for the translation and support of Composr in your native language.
  • Reporting translation issues: If you encounter unclear, incorrect, or duplicated language strings, file bug reports.
  • Providing feedback and suggestions: Share your thoughts on improving the translation process through feature suggestions.
Your contributions are valuable and help make Composr accessible to a wider audience.
Question What is Transifex, and how does it help with translation?
Answer Transifex is a collaborative online platform used by the Composr community for translation. Its benefits include:
  • Centralized translation efforts: Multiple translators can work on the same project.
  • Improved translation quality: The platform facilitates consistency and accuracy.
  • Simplified language pack creation: You can generate downloadable language pack addons directly from Transifex.
We encourage using Transifex for translation to foster collaboration and maintain high-quality translations.
Question Can I translate images with text on them?
Answer Yes, you can translate images containing text. In the themes/default/images/ directory, you'll find an EN folder containing images with English text.
  • Copy the EN folder: Create a new folder with the ISO code of your target language (e.g., FR for French).
  • Replace the images: Replace the English images with translated versions.
  • Ensure correct image paths: Update any references to these images in your templates or content to point to the translated versions.
Question How do I translate the content on my Composr website?
Answer Once you've installed a new language pack, you can translate existing content by:
  • Editing the content directly: Go to the specific content item (page, news post, etc.) and edit it in the new language.
  • Using the language editor: Access the language editor from Admin Zone > Style > Translate/rephrase Composr to modify language strings used on specific pages.
Note that some elements like forum names are not designed to be translated directly. Instead, you should create separate forums for each language.
Question How do I change the language of my Composr website?
Answer Composr comes with English as the default language. To change to a different language:
  • Download the language pack: You can download language packs from the Composr website.
  • Install the language pack: Upload the downloaded language pack addon through Admin Zone > Structure > Addons > Import non-bundled addon(s).
  • Change the default language: Go to http://yourbaseurl/config_editor.php and set the desired language.
  • Update your profile: If you had a previous language set in your profile, update it to the new language.

You can test a language without changing settings by appending &keep_lang=XX to the URL, where XX is the language code (e.g., FR for French).
Question What should I do after successfully importing data into Composr?
Answer After importing, if all files like avatars, photos, and attachments have been copied to Composr's directories, you can remove the imported product's directory. However, it's advisable to keep the directory, database, and import session for a few weeks in case any data was not correctly imported and needs further attention. Importing is a complex process, so keeping backups and sources for a while is a good practice.
Question Where can I get help with the import process?
Answer The Composr documentation provides extensive information. Additionally, you can seek assistance from experienced Composr developers, including the Composr team if your project allows for professional support.
Question Can I switch from a third-party forum to Conversr (Composr's built-in forum)?
Answer Yes, if an importer exists for your current forum software, you can switch to Conversr during the import process. Composr will handle the forum driver switch and remap user IDs, but it's recommended to double-check permissions afterward.
Question How does the HTML website importer work?
Answer The HTML website importer is an advanced tool for migrating static HTML websites to Composr. It analyzes the HTML structure to create zones, Comcode pages, and a basic template. It also attempts to fix links and file paths for Composr compatibility.
Question What is a Composr import session?
Answer Import sessions track the progress and ID remapping for each import, allowing you to merge multiple sites or resume interrupted imports. This is particularly useful when merging multiple Composr sites into one.