Featured Sites: A-Z Index

H


Newest 10 Entries

Question Should I update my non-bundled addons after updating to a newer release of version 11?
Answer

Absolutely! Frequent changes may be made to both bundled and non-bundled addons. Bundled addons will be updated via the upgrader. For non-bundled addons, you will have to update them through the addons management screen (Admin Zone > Structure > Addons). You will be informed which ones need updated.

Once version 11 reaches release candidate, we do not expect frequent updates to non-bundled addons anymore. But it is still good practice to check after every update.

Question Can I upgrade a version 10 site to version 11?
Answer

Yes, for basic non-custom v10 sites. However, expect some issues to arise in the process. And please report those issues to the tracker.

For v10 sites with non-bundled addons or customisations, upgrading to v11 will likely break the site until you update the non-bundled addons or temporarily remove the customisations.

We aim to have the upgrader fully functional for a large majority of types of sites and for sites using non-bundled addons by the time version 11 reaches release candidate stage.

We do not recommend upgrading production v10 sites at this time until v11 reaches stable.

Question Can I upgrade a previous version 11 release to a newer one using the upgrader?
Answer

Yes (probably). Always remember especially during alpha and beta phases that things can break. Please make backups first. And let us know on the issue tracker if an issue occurs.
 

Note: You cannot upgrade from 11 alpha to 11 beta without first upgrading to 11.alpha4 (if you are not already on 11.alpha4).

Question What are the current release plans for version 11?
Answer

As of July 22, 2024, we entered beta status where our focus is now smashing bugs and stabilising the software. All planned features have been implemented for 11.0 (and most others deferred to 11.1 or later), though we may still merge in a few minor features or tweaks. The upgrader has been tested on a typical non-custom v10 site.

We will be releasing several beta versions in the beta phase.

We do not know when we will be able to release the first Release Candidate or stable versions at this time.

These plans are all subject to change without notice.

Question Why is there a separate website for version 11?
Answer That is explained in detail in this news article on compo.sr including the migration plans and implications.

Top 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.