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 Can I leave notes for myself or other staff members?
Answer Yes, the Admin Zone includes a dedicated "Notes" block for you and your staff to leave messages and reminders. This space serves as a shared communication hub for your team.
Question How can I stay informed about the latest Composr version?
Answer The Admin Zone dashboard displays information about your current Composr version and alerts you if it's not the most recent one. A link will be provided to guide you through the upgrade process if necessary.
Question What is the action log, and how can I use it?
Answer The action log keeps track of administrative and content-related actions on your website. It allows you to see who did what and when, providing valuable insights into site activity and accountability. You can filter the log to focus on specific actions, users, or timeframes. It's also helpful for revisiting previous tasks by providing links to the relevant content or settings.
Go to the Admin Zone > Audit > Action logs. A quick action log block is also available on the dashboard.
Question What is the staff checklist in the Admin Zone?
Answer The staff checklist is an automatically generated list of tasks that need attention on your website. It includes routine updates like assigning new awards or adding news, as well as less frequent but important tasks like backups, software updates, newsletters, content validation, and periodic content reviews. You can customize the frequency of these tasks in the 'Configuration' section under 'Administrative options'. You can also add your own custom tasks. Anyone with Admin Zone access can see the checklist. So you can collaborate with your highest level staff on it.
Question I'm lost! How can I find a specific feature or setting?
Answer The Admin Zone has a powerful search feature that you can access under the Help icon. It searches through various categories, including configuration options, privileges, templates, language strings, administrative modules, and more. You can even refine your search by adding "@sectionname" to the end of your search term to limit results to a specific section.
Question How do I access the Admin Zone?
Answer You can access the Admin Zone by clicking the "Admin Zone" link located at the bottom of every page on your website, assuming you are using the default theme. If you are logged in as a staff member, your user menu will also have a link to the Admin Zone or the Content Management Zone. You might be asked to log in again / confirm your session for security reasons.
Question What is the Admin Zone?
Answer The Admin Zone is a special section of your Composr website that allows authorized staff members to perform various administrative tasks. It serves as the central hub for managing content, configuring settings, monitoring activity, and maintaining the overall health of your website.
Question What should I avoid doing in Composr to maintain accessibility?
Answer Avoid using Comcode tags or other HTML elements that create dynamic effects in the user's browser, such as ticker and jumping. These can have a negative impact on navigation and scrolling.
Provide alternate information for multimedia you upload so those with auditory impairments can still understand the content.
Avoid creating multiple content items with the same title, as this can lead to accessibility issues and general user confusion.
Question How does Composr handle forms for accessibility?
Answer The web standards checker ensures that form labels are properly positioned and explicitly associated with their controls.
It also checks that form elements have a logical tab order and are keyboard operable.
Question How does Composr ensure accessible data tables?
Answer The web standards checker enforces proper markup for data tables, including identifying row and column headers, and associating data cells with header cells.
It ensures that tables are not used for layout (flex boxes and HTML grids are preferred for mobile responsiveness) unless they make sense when linearized.
Composr provides summaries for tables to aid non-visual user agents in understanding their structure and content.