Featured Sites: A-Z Index

H


Newest 10 Entries

Question How do I set the correct file permissions for Composr?
Answer If you're using the quick installer, it will handle file permissions automatically. On a suEXEC-style server, default permissions (744 for directories and 644 for files) are usually sufficient. However, _config.php should have 600 permissions for security.

Without suEXEC, specific directories (e.g., caches, uploads) and files (e.g., _config.php) require 777 (full access) or 666 (read/write) permissions. The fixperms.php script can automate this process on Linux and Windows.
Question How do I install Composr on Linux?
Answer After ensuring your web host meets the requirements and you have a database ready, you can install Composr on Linux using the following steps:
  • Upload the Composr files to your web directory.
  • Navigate to the install.php file in your web browser.
  • Follow the on-screen instructions, providing the required information, such as database details and administrator credentials.
  • After the installation is complete, delete the install.php file for security reasons.
Question What are the prerequisites for installing Composr?
Answer Before installing Composr, ensure your web host meets the minimum requirements. Familiarize yourself with your web host's control panel (e.g., Plesk, cPanel), which you'll use to manage databases, subdomains, and other settings. Gather your SFTP/FTP credentials (hostname, username, password), usually emailed upon signup. Set up a MySQL database and note its details: hostname (often 'localhost'), username, password, and database name. Ensure the database user has full read/write/administer access to the database.
Question What tools are available for debugging Composr code?
Answer Composr offers a code quality checker addon that helps identify various types of errors, including parser errors, run-time errors, and logical errors. This tool can significantly reduce debugging time and enhance code reliability. It is available through the testing_platform addon.
Question What are some key coding standards in Composr?
Answer Composr emphasizes clean, well-structured code with a focus on readability and maintainability. Key standards include proper indentation, consistent use of comments, and clear function headers with type definitions. Remember: beautiful code leads to better functionality and collaboration!
Question Where can I find resources for learning PHP programming?
Answer While Composr documentation doesn't cover basic PHP, resources like the official PHP documentation (

PHP: Hypertext Preprocessor

PHP is a popular general-purpose scripting language that powers everything from your blog to the most popular websites in the world.

View

), online tutorials, and the Composr API guide can help you learn.
Question What is the purpose of the Code Editor?
Answer The Code Editor is a web-based tool for editing Composr code files directly on the server. It requires password authentication and automatically manages overrides within _custom directories.

To access it, go to yourbaseurl/code_editor.php.
Question How can I export and import custom addons?
Answer Composr allows exporting addons as TAR files, containing all necessary files and an addon.inf file for metadata. You can import these addons to share and reuse them across different Composr installations.

To do this, make your necessary files for the addon in the Composr installation, and then go under Admin Zone > Structure > Addons > Export addon. You can select the relevant files for the addon, provide information about the addon, and then download the TAR file (which can then be imported on other Composr sites).
Question Can you give an example of creating a new module?
Answer Imagine creating a "Testing" module to manage collaborative testing:
  • Define purpose: Allow testers to add, assign, and track tests, with security and forum integration.
  • Design database: Plan the necessary database tables and fields to store the module's data.
  • Create module shell: Write the basic module structure based on standard Composr modules.
  • Define screens: Identify the module's screens and code their corresponding functions.
  • Utilize API functions: Use Composr's built-in API functions like create_table, add_privilege, and do_template to implement functionality.
Question What are the different ways to extend Composr functionality?
Answer You can extend Composr through:
  • File overrides: Replacing existing source files with modified versions in _custom directories.
  • New Modules/Mini-modules: Creating new modules for complex functionalities or mini-modules for simpler ones.
  • New Blocks/Miniblocks: Adding reusable content blocks.
  • New API code: Adding new PHP files to the sources_custom directory.
  • Hooks: Writing hooks to add features to specific areas of functionality.

Top 10 Entries

Question What are "breadcrumbs," and how can I customize them?
Answer Breadcrumbs are a navigation aid that shows the user their current location within the website's hierarchy. In Composr, breadcrumbs are customizable through an XML file.

You can override default breadcrumbs using "match-keys" to target specific pages and define the desired breadcrumb structure. This allows you to adjust the breadcrumb trail to better match your website's organization.

To edit, go to Admin Zone > Structure > Configure breadcrumb overrides.
Question How can I control which panels are displayed on specific pages?
Answer Panels are the areas around your main content area where you can place menus, blocks, and other dynamic elements. You can control panel visibility using display rules within your panel's Comcode:
{+START,IF,{$NEQ,{$PAGE},example_page_1,example_page_2,example_page_3}}
... panel content ...
{+END}

This example prevents the panel from showing on pages named "example_page_1," "example_page_2," and "example_page_3."
Question What is a "page-link," and how does it differ from a URL?
Answer A page-link is a Composr-specific way to reference a page or screen within your website. It's a simplified, local representation of a URL, independent of the URL scheme you might be using.

For example, the page-link site:downloads:browse:10 points to the download category with ID 10 in the site zone. This page-link remains consistent even if your URL scheme changes the way URLs are structured. Page-links also do not consider monikers, so if a URL moniker changes, page-links will stay the same.

This is a powerful feature as you can use the Comcode [page="page-link"]Page title[/page] tag to generate URLs of local content. And these will always work regardless of URL scheme or moniker.
Question How do menus work in Composr, and can I customize them?
Answer Composr has a flexible menu system that can be customized to your needs.
  • Default Menu: Generated automatically from the Sitemap, reflecting the structure of your content.
  • Editable Menus: You can create and fully customize these menus, adding links to specific content or external websites.

Menus can be added to panels (sidebars, headers, footers) or embedded directly within Comcode pages. The menu editor provides tools for adding branches, setting captions, tooltips, and URLs, and even defining context-sensitive behavior using "match-keys."
Question What are "zones" in Composr, and what are they used for?
Answer Zones are like sub-sites within your Composr website. They provide a way to organize content and apply different settings, like permissions, themes, and navigation. Some default zones include:
  • Welcome Zone: The initial landing page, often used for login/signup.
  • Site Zone: Your main website content, with features for viewing, submitting, editing, and deleting content on the member level.
  • Admin Zone: For site administrators to manage the website.
  • Content Management Zone: Where content is added, edited, and deleted, typically by site staff.
  • Forum Zone (if using Conversr): Houses the forum section of your site.
Question What are the different ways to control access in Composr?
Answer Composr offers a robust permission system with various methods for controlling access:
  • Zones, Pages, and Categories: Control which usergroups can view specific zones, pages, and categories (permissions).
    • Admin Zone > Security > Permissions Tree Editor, or on the UI for the Zone / Page / Category.
  • Global Privileges: Define permissions for actions like using advanced Comcode or bypassing the word filter, applicable across the entire site.
    • Admin Zone > Security > Global privileges
  • Module/Page Overrides: Tailor privileges for particular content types by overriding them on the controlling module or page.
    • Admin Zone > Security > Permissions Tree Editor [> Content permissions]
  • Category Overrides: Modify privileges for specific categories, allowing fine-grained control over actions within those categories.
    • Admin Zone > Security > Permissions Tree Editor
  • Match-key Permissions: Implement ad-hoc access control based on specific match-keys, offering flexibility beyond traditional permission structures.
    • Admin Zone > Security > Match-key page restrictions
Question What happens when I add a new usergroup to a third-party forum integrated with Composr?
Answer If you are not using Conversr as your forum, Composr won't automatically assign any permissions to the new usergroup. To rectify this, you can use the "Absorb usergroup-permissions" feature in the Admin Zone. This tool allows you to copy the permissions from an existing usergroup to the newly created one, ensuring consistent access and functionality.
Question What are some security considerations regarding super-moderators and super-administrators?
Answer While super-moderators have extensive access to manage your site, certain sensitive privileges are reserved for super-administrators. This includes the ability to impersonate other users, execute arbitrary code, and view private content. These restrictions help prevent potential privilege escalation and ensure the overall security of your website. Exercise caution when granting super-moderator status and trust only reliable individuals.
Question What are some useful tools for debugging permission issues?
Answer Composr provides a couple of tools to help pinpoint permission problems:
  • FirePHP: This browser add-on allows you to view detailed logs of permission checks performed by Composr. By analyzing these logs, you can identify which checks are failing and adjust your settings accordingly.
  • Permission Check Logging: Enable logging of failed permission checks to a file (data_custom/permission_checks.log). This provides a persistent record of permission issues that you can review and troubleshoot.
Question How can I test if my permission settings are working correctly?
Answer Composr's "SU" feature allows administrators to temporarily assume the identity of another user, enabling you to experience the site as they would. Simply enter the desired username in the "SU" box in the footer. You can also use "Guest" to browse as an unauthenticated visitor. Remember that using "SU" doesn't accurately reflect online status and retains administrator access to sensitive areas.