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 do I add dynamic content to my Comcode pages?
Answer Composr utilizes "blocks" to embed dynamic content and functionality within Comcode pages. These blocks can range from displaying recent forum posts to showing information about the logged-in user.

To add a block, you can use the "block construction assistant" accessible via a button above the editor. This tool provides a user-friendly way to:
  • Browse and select available blocks.
  • Configure the block parameters.
  • Preview the block output.
  • Generate the necessary Comcode to embed the block.
Question How do I create a new Comcode page?
Answer Composr provides two easy ways to create a new Comcode page:

Method 1: Direct URL Entry
Type the desired URL of your new page into your browser's address bar.
Since the page doesn't exist yet, Composr will present you with a 404 error and a link to create it. Click the link to open the Comcode page editor.

Method 2: Admin Zone
Navigate to Admin Zone > Content > Pages (Comcode pages).
Scroll down to the list of existing pages and enter the name of your new page using the ":" (page-link) format. For example, a new page in the Welcome zone named "about" would be entered as ":about", or a new page in the "site" zone named "foobar" would be entered as "site:foobar".
Question What are Comcode pages?
Answer Comcode pages are standalone content pages within the Composr system that you can create and edit using either a WYSIWYG editor, a simple markup language called Comcode, or a combination of both.

Think of them as documents within your website, offering flexibility beyond the structured content provided by modules like forums or news. You can use them to build landing pages, about us sections, contact pages, and more.
Question Can I create custom Comcode tags?
Answer Yes, you can create custom Comcode tags through the Admin Zone > Setup > Custom Comcode. This allows you to add unique functionality or wrap specific HTML code (especially if you use a certain block of HTML frequently on your site) for easier use. Custom Comcode tags can be tailored to your needs and even include your own parameters. You can also specify if the Comcode is dangerous so only those with elevated privileges can use it.
Question What are the security considerations when using Comcode?
Answer Composr has a multi-tiered security system for Comcode. HTML code is filtered based on user permissions to prevent XSS attacks. Content is parsed with different credentials depending on who is editing or adding it, ensuring users can't elevate their privileges by modifying existing content.
Question What is oEmbed and how does it work with Comcode?
Answer oEmbed is a system that allows you to embed content from other websites simply by pasting its URL. When you paste a supported link in Comcode, oEmbed will automatically embed the content for you in a nicely-formatted box. For example, pasting a YouTube video link will embed the video directly into your content so it can be played on your website.
Question How do I add attachments to my content?
Answer Composr has an integrated attachment system. You can upload files, like images or documents, via the attachments section (or the image button if using the WYSIWYG editor with simplified attachments UI), and they will be automatically added to your Comcode using the attachment tag. You can then move this tag within your content to position the attachment as needed.
Question How do I use Comcode tags?
Answer Comcode tags are similar to HTML tags, but use square brackets [] instead of angle brackets <>. Each tag has an opening and closing tag, with content in between.

Example: [b]This text would be bold.[/b]

Tags can also have parameters:
Example: [img src="image.jpg" alt="Image description"]

A shorthand exists for the param parameter (the primary parameter of Comcode tags):
Example: [page="_SEARCH:howdy_do"]Howdy do[/page]
Question What are the advantages of using Comcode?
Answer Comcode offers several advantages:

Intuitive content authoring: It's written like plain text, making it easy to learn and use.
Dynamic functionality: You can embed dynamic content like blocks, comments, and forms using Comcode.
Special effects: You can easily add prebuilt graphical features like tabs, carousels, and more.
Basic styling and layout: Comcode allows for basic website styling and page layout.
HTML integration: For advanced styling and layout, you can embed HTML code within Comcode with the semihtml tag.
Question What is Comcode?
Answer Comcode is Composr's markup language, similar to BBCode used in forums. It allows you to create formatted text, embed dynamic content like blocks and attachments, and even mix in HTML for advanced styling. It's user-friendly and designed to work alongside standard web technologies.