Maarch Framework 3/Developer handbook/Notes

De Maarch // Wiki.

Cette section du wiki est en cours de restructuration et de rédaction. Nous nous excusons pour la gêne occasionnée. This section of the wiki is under heavy restructuring and writing. We're sorry for the inconvenience.

Summary

Installation

Quick Install

The tables for this module are defined in the file notes/sql/structure/ directory depending on your databasetype, and the mimimal data in the notes/sql/data/ directory. For the moment, we provide only mysql and postgresql scripts, but it is not difficult to build script for other database with existing scripts.

To load the module just add these lines in the apps config.xml file in the <MODULES> section :

<MODULES>
   <moduleid>notes</moduleid>
   <comment>_NOTES</comment>
</MODULES>

Make sure the service is active (the <loaded> tag is set to true in notes/xml/config.xml).

Setting

config.xml file

<?xml version="1.0" encoding="utf-8"?>
<root>
	<CONFIG>
		<name>notes</name> <!-- module name : MUST BE THE DIRECTORY NAME OF THE MODULE -->
		<comment>_NOTES</comment> <!-- Label of the module, defined in the notes language file -->
		<file_prefix>not</file_prefix>
		<loaded>true</loaded> <!-- must be true otherwise the services will not work -->
	</CONFIG>
	<TABLENAME> <!-- Module specific tables -->
		<not_notes>notes</not_notes>
	</TABLENAME> 
	<HISTORY> <!-- Module specific tables -->
		<noteadd>true</noteadd>	<!-- Add a new note -->			
		<noteup>true</noteup>	<!-- Modify a note -->					
		<notedel>true</notedel> <!-- Delete a note -->
	</HISTORY>
</root>

The <HISTORY> tag contains the list of all events that can be logged. To disable one, just set its tag to false.

Provided Services

All the localization constants used in service.xml are defined in the notes languages files.

All the css styles defined in the <style> tag are defined in css files of the notes/css directory.

By default, some service are defined as system services, it means that these services will be activated for all users. You can easily modify it by setting the <system_service> tag to false.

To deactivate a service, simply set the <enabled> tag to false.

manage_notes_doc

This service displays the notes of a given document and grant permission to read notes, add a new one and delete our notes.

<SERVICE>
   <id>manage_notes_doc</id>
   <name>_MANAGE_NOTES</name>
   <comment>_MANAGE_NOTES_DESC</comment>
   <servicepage>notes_doc.php</servicepage>
   <servicetype>use</servicetype>
   <system_service>true</system_service>
   <enabled>true</enabled>
    <WHEREAMIUSED>
     <page>details_invoices.php</page>
     <nature>include</nature>
   </WHEREAMIUSED>
 </SERVICE>

This service is an use service. This is a system service by default.

Customisation