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 improve my search results?
Answer Here are some tips for improving search results:
  • Use specific keywords: The more specific your keywords, the better your results.
  • Use boolean operators: Use "+", "-", and quotation marks to refine your search.
  • Optimize content titles and meta keywords: These fields are given priority during search, so make sure they accurately reflect your content.
  • Consider enabling the fast custom index: Especially beneficial for large websites or frequent filtered searches.
Question What is the fast custom index and why should I use it?
Answer The fast custom index is Composr's own search engine, designed to be faster and more efficient than MySQL full-text search, especially for large websites and filtered searches.

Benefits of the fast custom index:
  • Faster filtered searches: Significantly improves search speed when you add filters like category or author.
  • Configurable stop words: Control which common words are ignored during search.
  • Better stemming: More accurately recognizes variations of words (e.g., "like" and "liking").
  • Multilingual support: Indexes content based on different language translations.

Downsides of the fast custom index:
  • Slight lag in indexing new content: New content takes a short time to be indexed.
  • Less accurate ranking: Ranking is based on the most obscure keyword, not a blend of all keywords.
  • Cannot perform blank searches: You must enter at least one keyword.
Question Can I filter my search results?
Answer Yes, you can filter your search results by:
  • Content type: Choose to search specific content types like news, forum posts, or Comcode pages.
  • Author/Submitter: Search for content submitted by a specific member.
  • Date: Limit your search to content submitted within a specific time frame.
  • Category (for certain content types): Narrow down your search to specific categories within a content type.
Question What is the difference between natural and boolean searching?
Answer Natural search is a more relaxed approach where you type in your search terms and Composr tries to find the most relevant results, even if they don't contain all the words. It's like a Google search.

Boolean search requires more precision and uses operators like "+", "-", and quotation marks to define exactly what you're looking for. For example, searching for "+car -maintenance" will only return results that contain the word "car" but not "maintenance".
Question How do I search my Composr website?
Answer There are a few ways to search your Composr website:
  • Using the search bar in the header: This is the simplest way to search. Just type your search term in the box and click the search button.
  • Using the 'Search' module: This module offers more detailed search options. You can access it via the 'site:search' page-link (usually under About > Search in the default menu).
  • From the Forum: Click the 'Search' button on the forum or use the contextual search box on the forum member bar. This will search within your current forum or topic.
Question How do I mark correct answers in a quiz?
Answer For questions with predefined answers, you can mark correct answers by adding [*] after the answer. If no answer is marked correct, the question will require manual marking. You can also use the [UNMARKED] tag after a question to exclude it from scoring.
Question What is the input syntax for quiz questions?
Answer Quiz questions are inputted in blocks, separated by blank lines. The first line is the question, followed by potential answers on subsequent lines. Different question types are indicated by tags after the question, such as [MULTIPLECHOICE], [MULTIMULTIPLE], [LONG], [SHORT], and [SHORT_STRICT].
Question Can I create complex, multi-screen quiz interfaces in Composr?
Answer While Composr's built-in quiz system is excellent for standard formats, creating intricate multi-screen quizzes might require custom development using Composr's decision tree framework or other programming tools. This allows for highly customized quiz structures and advanced branching logic.
Question How can I analyze quiz results effectively?
Answer Composr enables you to export quiz results to a spreadsheet file, facilitating in-depth data analysis. This is especially useful for manually marked questions, identifying competition winners, and processing data for marketing or research purposes.
Question What are Quiz Sets and how can I use them?
Answer Quiz Sets are a helpful organizational feature in Composr. By prefixing quiz names with "Example: ", you can group related quizzes together. This allows for combined scoring and percentage calculations, particularly beneficial for multi-part questionnaires or tests.