GitBook: [master] 27 pages and 62 assets modified

XoopsDocs · May 12, 2020 · a7758cb · a7758cb
1 parent e5c5480
commit a7758cb
Show file tree

Hide file tree

Showing 56 changed files with 308 additions and 339 deletions.
diff --git a/en/assets/2About.jpg → .gitbook/assets/2about.jpg b/en/assets/2About.jpg → .gitbook/assets/2about.jpg
diff --git a/en/assets/2Build.jpg → .gitbook/assets/2build.jpg b/en/assets/2Build.jpg → .gitbook/assets/2build.jpg
diff --git a/en/assets/2Dashboard.jpg → .gitbook/assets/2dashboard.jpg b/en/assets/2Dashboard.jpg → .gitbook/assets/2dashboard.jpg
diff --git a/en/assets/2Feedback.jpg → .gitbook/assets/2feedback.jpg b/en/assets/2Feedback.jpg → .gitbook/assets/2feedback.jpg
diff --git a/en/assets/2Fields.jpg → .gitbook/assets/2fields.jpg b/en/assets/2Fields.jpg → .gitbook/assets/2fields.jpg
diff --git a/en/assets/2FieldsDetails.jpg → .gitbook/assets/2fieldsdetails.jpg b/en/assets/2FieldsDetails.jpg → .gitbook/assets/2fieldsdetails.jpg
diff --git a/en/assets/2FieldsVisibility.jpg → .gitbook/assets/2fieldsvisibility.jpg b/en/assets/2FieldsVisibility.jpg → .gitbook/assets/2fieldsvisibility.jpg
diff --git a/en/assets/2Help.jpg → .gitbook/assets/2help.jpg b/en/assets/2Help.jpg → .gitbook/assets/2help.jpg
diff --git a/en/assets/2Migrate.jpg → .gitbook/assets/2migrate.jpg b/en/assets/2Migrate.jpg → .gitbook/assets/2migrate.jpg
diff --git a/en/assets/2MigrateSchemaFile.png → .gitbook/assets/2migrateschemafile.png b/en/assets/2MigrateSchemaFile.png → .gitbook/assets/2migrateschemafile.png
diff --git a/en/assets/2MigrateShowSQL.jpg → .gitbook/assets/2migrateshowsql.jpg b/en/assets/2MigrateShowSQL.jpg → .gitbook/assets/2migrateshowsql.jpg
diff --git a/en/assets/2MigrateWriteSchema.jpg → .gitbook/assets/2migratewriteschema.jpg b/en/assets/2MigrateWriteSchema.jpg → .gitbook/assets/2migratewriteschema.jpg
diff --git a/en/assets/2ModuleEdit.jpg → .gitbook/assets/2moduleedit.jpg b/en/assets/2ModuleEdit.jpg → .gitbook/assets/2moduleedit.jpg
diff --git a/en/assets/2Modules.jpg → .gitbook/assets/2modules.jpg b/en/assets/2Modules.jpg → .gitbook/assets/2modules.jpg
diff --git a/en/assets/2MoreFiles.jpg → .gitbook/assets/2morefiles.jpg b/en/assets/2MoreFiles.jpg → .gitbook/assets/2morefiles.jpg
diff --git a/en/assets/2MoreFilesForm.jpg → .gitbook/assets/2morefilesform.jpg b/en/assets/2MoreFilesForm.jpg → .gitbook/assets/2morefilesform.jpg
diff --git a/en/assets/2Settings.png → .gitbook/assets/2settings.png b/en/assets/2Settings.png → .gitbook/assets/2settings.png
diff --git a/en/assets/2Tables.jpg → .gitbook/assets/2tables.jpg b/en/assets/2Tables.jpg → .gitbook/assets/2tables.jpg
diff --git a/en/assets/2TablesExpand.jpg → .gitbook/assets/2tablesexpand.jpg b/en/assets/2TablesExpand.jpg → .gitbook/assets/2tablesexpand.jpg
diff --git a/en/assets/3preferences.jpg → .gitbook/assets/3preferences.jpg b/en/assets/3preferences.jpg → .gitbook/assets/3preferences.jpg
diff --git a/en/assets/Admin.png → .gitbook/assets/admin.png b/en/assets/Admin.png → .gitbook/assets/admin.png
diff --git a/en/assets/CssAdminStyles.png → .gitbook/assets/cssadminstyles.png b/en/assets/CssAdminStyles.png → .gitbook/assets/cssadminstyles.png
diff --git a/en/assets/CssStyles.png → .gitbook/assets/cssstyles.png b/en/assets/CssStyles.png → .gitbook/assets/cssstyles.png
diff --git a/en/assets/DB_ModuleBuilder.jpg → .gitbook/assets/db_modulebuilder.jpg b/en/assets/DB_ModuleBuilder.jpg → .gitbook/assets/db_modulebuilder.jpg
diff --git a/en/assets/image001.png → .gitbook/assets/image001 (1).png b/en/assets/image001.png → .gitbook/assets/image001 (1).png
diff --git a/.gitbook/assets/image001.png b/.gitbook/assets/image001.png
diff --git a/en/assets/logoModule.png → .gitbook/assets/logomodule.png b/en/assets/logoModule.png → .gitbook/assets/logomodule.png
diff --git a/en/assets/logoXoops.jpg → .gitbook/assets/logoxoops (1).jpg b/en/assets/logoXoops.jpg → .gitbook/assets/logoxoops (1).jpg
diff --git a/.gitbook/assets/logoxoops.jpg b/.gitbook/assets/logoxoops.jpg
diff --git a/en/assets/TemplatesBlocks.png → .gitbook/assets/templatesblocks.png b/en/assets/TemplatesBlocks.png → .gitbook/assets/templatesblocks.png
diff --git a/en/assets/uml_output.png → .gitbook/assets/uml_output.png b/en/assets/uml_output.png → .gitbook/assets/uml_output.png
diff --git a/en/assets/UserDefstyle.png → .gitbook/assets/userdefstyle.png b/en/assets/UserDefstyle.png → .gitbook/assets/userdefstyle.png
diff --git a/en/book/10aboutxoops.md → 10aboutxoops.md b/en/book/10aboutxoops.md → 10aboutxoops.md
@@ -1,30 +1,30 @@
-![](../assets/logoXoops.jpg)
+# About XOOPS CMS
 
-# 10.0 About XOOPS CMS
+![](.gitbook/assets/logoxoops.jpg)
 
-XOOPS is a Content Management System (CSM) and a Web Portal program that allows administrators to easily create dynamic websites with great content and many outstanding features. It is an ideal tool for developing small to large dynamic community websites, intra company portals, corporate portals, weblogs and much more. It can be installed on an Internet host with a PHP-capable web server (e.g., Apache) and a database (e.g., MySQL).
+## 10.0 About XOOPS CMS
 
-**The main Project websites is https://xoops.org**
+XOOPS is a Content Management System \(CSM\) and a Web Portal program that allows administrators to easily create dynamic websites with great content and many outstanding features. It is an ideal tool for developing small to large dynamic community websites, intra company portals, corporate portals, weblogs and much more. It can be installed on an Internet host with a PHP-capable web server \(e.g., Apache\) and a database \(e.g., MySQL\).
 
-XOOPS is released under the terms of the GNU General Public License (GPL) and is free to use and modify. It is free to redistribute as long as you abide by the distribution terms of the GPL.
+**The main Project websites is** [https://xoops.org](https://xoops.org)
+
+XOOPS is released under the terms of the GNU General Public License \(GPL\) and is free to use and modify. It is free to redistribute as long as you abide by the distribution terms of the GPL.
 
 **What XOOPS stands for:**
 
 XOOPS is an acronym of eXtensible Object Oriented Portal System. Though started as a portal system, XOOPS is in fact striving steadily on the track of Content Management System. It can serve as a web framework for use by small, medium and large sites.
 
-It is highly scalable, from a personal weblog or journal through a community website to an enterprise installation. It has numerous modules that can be used to create all the basic functionality required of the system, e.g. News, Forums, Downloads, Web Links etc.  Customized modules can also be developed by users and integrated seamlessly with the core to serve specific needs such as eCommerrce.
+It is highly scalable, from a personal weblog or journal through a community website to an enterprise installation. It has numerous modules that can be used to create all the basic functionality required of the system, e.g. News, Forums, Downloads, Web Links etc. Customized modules can also be developed by users and integrated seamlessly with the core to serve specific needs such as eCommerrce.
 
 **Pronunciation guide**
 
-The standard pronunciation of XOOPS follows English rules, and is pronounced [zoo'ps].
+The standard pronunciation of XOOPS follows English rules, and is pronounced \[zoo'ps\].
 
-###**Key features of XOOPS**
+### **Key features of XOOPS**
 
 **Database-driven**
 
-XOOPS uses a relational database (currently MySQL) to store data required for running a web-based content management system.
-Fully Modularized
-Modules can be installed, uninstalled, and activated or deactivated with a click using the XOOPS module administration system.
+XOOPS uses a relational database \(currently MySQL\) to store data required for running a web-based content management system. Fully Modularized Modules can be installed, uninstalled, and activated or deactivated with a click using the XOOPS module administration system.
 
 **Personalization**
 
@@ -50,41 +50,31 @@ XOOPS comes with a powerful and user-friendly permissions system which enables a
 
 XOOPS is driven by a powerful theme system. Both administrators and users can change the look of the entire web site with just a click of a mouse. There are also over 60 themes available for download!!
 
-**XOOPS has received numerous awards: **
-
-It was a Finalist for the Best Project of SourceForge 2008 Community Awards and finalist for Best PHP Open Source CMS organized by Packt Publishing.  In addition, XOOPS received Awards from “Adobe Edge” as a Top CMS, received 5 out of 5 Stars from Germany's CHIP Magazine, or placed as a top CMS on a list published by ONDD.
+**XOOPS has received numerous awards:** 
 
-XOOPS has over 6,600,000 downloads from the SourceForge Website. 
+It was a Finalist for the Best Project of SourceForge 2008 Community Awards and finalist for Best PHP Open Source CMS organized by Packt Publishing. In addition, XOOPS received Awards from “Adobe Edge” as a Top CMS, received 5 out of 5 Stars from Germany's CHIP Magazine, or placed as a top CMS on a list published by ONDD.
 
-###**The current development is on GitHub: **
+XOOPS has over 6,600,000 downloads from the SourceForge Website.
 
+### **The current development is on GitHub:**
 
 To see what's coming, please check out our **XOOPS GitHub repositories**:
 
-- [XOOPS 2.6.0 Core](https://github.com/XOOPS)
-
-- [XOOPS 2.6.0 Modules](https://github.com/XoopsModules26x)
-
-
-- [XOOPS 2.6.0 Roadmap](https://github.com/XOOPS/XoopsCore/labels/roadmap)
+* [XOOPS 2.6.0 Core](https://github.com/XOOPS)
+* [XOOPS 2.6.0 Modules](https://github.com/XoopsModules26x)
+* [XOOPS 2.6.0 Roadmap](https://github.com/XOOPS/XoopsCore/labels/roadmap)
 
 and the new GUI:
 
-- [XOOPS 2.6.0 Enhanced Admin GUI](https://github.com/XOOPS/XoopsCore/issues/252)
-
+* [XOOPS 2.6.0 Enhanced Admin GUI](https://github.com/XOOPS/XoopsCore/issues/252)
 
 Please also check out our other Github repositories:
 
-- [XOOPS Documentation](https://github.com/XoopsDocs)
-
-- [XOOPS current Themes](https://github.com/XoopsThemes)
-
-- [XOOPS 2.5.x Modules](https://github.com/XoopsModules25x)
-
-- [XOOPS 2.0.14+ Themes, 3 columns](https://github.com/XoopsThemes25xArchive-3col)
-
-- [XOOPS 2.0.14+ Themes (2 columns)](https://github.com/XoopsThemes25xArchive-2col)
-
-- [XOOPS Theme Archive (Themes for XOOPS < 2.0.14)](https://github.com/XoopsThemesArchive)
+* [XOOPS Documentation](https://github.com/XoopsDocs)
+* [XOOPS current Themes](https://github.com/XoopsThemes)
+* [XOOPS 2.5.x Modules](https://github.com/XoopsModules25x)
+* [XOOPS 2.0.14+ Themes, 3 columns](https://github.com/XoopsThemes25xArchive-3col)
+* [XOOPS 2.0.14+ Themes \(2 columns\)](https://github.com/XoopsThemes25xArchive-2col)
+* [XOOPS Theme Archive \(Themes for XOOPS &lt; 2.0.14\)](https://github.com/XoopsThemesArchive)
+* [XOOPS Modules Archive](https://github.com/XoopsModulesArchive)
 
-- [XOOPS Modules Archive](https://github.com/XoopsModulesArchive)
diff --git a/en/book/1install.md → 1install.md b/en/book/1install.md → 1install.md
@@ -1,16 +1,10 @@
-# 1.0 Install/Uninstall
-
-1. Installation follows the usual XOOPS process. After downloading the module distribution pack, decompress the file and open the folder and any nested folder beneath until you find the main module files. These will be in a folder containing the "xoops_version.php" file. This parent folder will be uploaded to your server into the '/modules' directory. Now open and view the '/docs/readme.txt' files and follow any directions given, in case there pre-install configurations required for this module.   
+# Install/Uninstall
 
+1. Installation follows the usual XOOPS process. After downloading the module distribution pack, decompress the file and open the folder and any nested folder beneath until you find the main module files. These will be in a folder containing the "xoops\_version.php" file. This parent folder will be uploaded to your server into the '/modules' directory. Now open and view the '/docs/readme.txt' files and follow any directions given, in case there pre-install configurations required for this module.
 2. Using your usual FTP client upload the module directory to you '/modules' directory of your website files.
-
-3. Open your website administration page and go to 'Admin -> System Module -> Modules' 
-
+3. Open your website administration page and go to 'Admin -&gt; System Module -&gt; Modules'
 4. Install the module by clicking the install link. A confirmation page should give you a link back to 'Module Administration' page
-
 5. Happy XOOPSing and May the Source be with You!!!
 
-
-FYI: More detailed instructions on installing modules are available in the [**Chapter 2.12 of our XOOPS Operations Manual**](https://www.gitbook.com/book/xoops/xoops-operations-guide/) 
-
+FYI: More detailed instructions on installing modules are available in the [**Chapter 2.12 of our XOOPS Operations Manual**](https://www.gitbook.com/book/xoops/xoops-operations-guide/)
 
diff --git a/2administration.md b/2administration.md
@@ -0,0 +1,146 @@
+# Administration Menu
+
+![](.gitbook/assets/image001.png)
+
+_Figure 1: Main view of the ModuleBuilder \(Admin side\)_
+
+## Dashboard
+
+![](.gitbook/assets/2dashboard.jpg)
+
+_Figure 2: Import and Export of your current database \(Admin side\)_
+
+When you start working with XOOPS ModuleBuilder, you can import our sample definition of a module. This will help you to understand the settings of a module, its tables, and individual fields.
+
+If you create a very cool module, you can export the database and share with others, so they can import it and improve it or customize for their individual needs.
+
+## Settings
+
+![](.gitbook/assets/2settings.png)
+
+_Figure 3: Module Settings \(Admin side\)_
+
+You can define the Default settings for your future modules. Every new module will start with these values
+
+## Modules
+
+![](.gitbook/assets/2modules.jpg)
+
+_Figure 4a: Module List \(Admin side\)_
+
+In this tab you can see list of all you modules that you've worked on.
+
+![](.gitbook/assets/2moduleedit.jpg)
+
+_Figure 4b: Module Settings\(Admin side\)_
+
+Here you can define the details of your new module.
+
+## Tables
+
+![](.gitbook/assets/2tables.jpg)
+
+_Figure 5: Table List \(Admin side\)_
+
+In the Tables tab, you can see all you modules
+
+![](.gitbook/assets/2tablesexpand.jpg)
+
+_Figure 6: Expanding module \(Admin side\)_
+
+Click on this icon to expand the module and show all its tables. On the right hand sid you can click on the icons to edit the module, or to see all the fields defined in the table
+
+## Fields
+
+![](.gitbook/assets/2fields.jpg)
+
+_Figure 7: Fields \(Admin side\)_
+
+Here you can see the tables, and you can edit the table settings, or you can edit the fields
+
+![](.gitbook/assets/2fieldsvisibility.jpg)
+
+_Figure 8: Expanding fields View \(Admin side\)_
+
+Before you go to edit the individual fields, you can click on the left icon - it will expand the table showing all the fields. You can then change the visibility of each field, i.e. if it will be visible in the list and in the form for Admin, as well as for the User
+
+![](.gitbook/assets/2fieldsdetails.jpg)
+
+_Figure 9: Fields details \(Admin side\)_
+
+Here you can edit the details for each field.
+
+## More Files
+
+![](.gitbook/assets/2morefiles.jpg)
+
+_Figure 10: More files \(Admin side\)_
+
+If you want to include additional files in a particular module, you can add them here
+
+![](.gitbook/assets/2morefilesform.jpg)
+
+_Figure 11: More Files Edit view \(Admin side\)_
+
+This is the information that you have to provide for the additional files
+
+## Building Module
+
+![](.gitbook/assets/2build.jpg)
+
+_Figure 12: Generating the new module \(Admin side\)_
+
+You're finally done \(or you think so\), so it's time to generate the module.
+
+To make sure that you don't overwrite you code, the default is to write the files to /uploads/modulebuilder/repository folder. But if you're sure that you want to overwrite you current files, you can select the module to overwrite. This will save you some time, as you don't have to copy the files from the /uploads folder.
+
+## Feedback
+
+![](.gitbook/assets/2feedback.jpg)
+
+_Figure 13: Feedback \(Admin side\)_
+
+Here you have the option to provide feedback and recommendations to the developers
+
+## Migrate
+
+![](.gitbook/assets/2migrate.jpg)
+
+_Figure 14: Migrate \(Admin side\)_
+
+For developers of the module, we provide a "Migration" option
+
+![](.gitbook/assets/2migrateshowsql.jpg)
+
+_Figure 15: View SQL differences\(Admin side\)_
+
+If the module database schema is in synch with the database, then there are no SQL commands here. However, since we just changed the version number of the module, there is no schema yet, therefore the "Show SQL" button shows all the code
+
+![](.gitbook/assets/2migratewriteschema.jpg)
+
+_Figure 16: Writing the schema \(Admin side\)_
+
+When you make changes to the ModuleBuilder database structure, you should update the schema stored in /sql folder.
+
+![](.gitbook/assets/2migrateschemafile.png)
+
+_Figure 17: Module schema file \(Admin side\)_
+
+This is how the schema file looks like. It will make updates from version to version much easier.
+
+## About
+
+![](.gitbook/assets/2about.jpg)
+
+_Figure 18: About information \(Admin side\)_
+
+Some additional information about this module, incl. the changelog
+
+## Help
+
+![](.gitbook/assets/2help.jpg)
+
+_Figure 19: Help view \(Admin side\)_
+
+Every module contains a Help information.
+
diff --git a/3preferences.md b/3preferences.md
@@ -0,0 +1,6 @@
+# Preferences
+
+In the Preferences you can customize the module:
+
+![](.gitbook/assets/3preferences.jpg)
+
diff --git a/4operations.md b/4operations.md
@@ -0,0 +1,2 @@
+# Operating Instructions
+
diff --git a/5userside.md b/5userside.md
@@ -0,0 +1,6 @@
+# The User Side
+
+The module is working only on the Admin side.
+
+There is no interaction with external users.
+
diff --git a/en/book/6blocks.md → 6blocks.md b/en/book/6blocks.md → 6blocks.md
@@ -1,3 +1,4 @@
-# 6.0 Blocks
+# Blocks
 
 There are no blocks, since the module is working only on the Admin side.
+
diff --git a/7templates.md b/7templates.md
@@ -0,0 +1,20 @@
+# Templates
+
+There are following Smarty templates for the Admin:
+
+* modulebuilder\_about.tpl
+* modulebuilder\_addfiles.tpl
+* modulebuilder\_addmymodule.tpl
+* modulebuilder\_building.tpl
+* modulebuilder\_fields.tpl
+* modulebuilder\_fields\_item.tpl
+* modulebuilder\_footer.tpl
+* modulebuilder\_header.tpl
+* modulebuilder\_index.tpl
+* modulebuilder\_modules.tpl
+* modulebuilder\_morefiles.tpl
+* modulebuilder\_moremymodule.tpl
+* modulebuilder\_settings.tpl
+* modulebuilder\_tables.tpl
+* modulebuilder\_tables\_item.tpl
+
diff --git a/80other.md b/80other.md
@@ -0,0 +1,5 @@
+# Miscellaneous
+
+* [DB Tables](https://github.com/XoopsDocs/modulebuilder-tutorial/tree/156ff4d4d9ddbb7c0debc9ad33712afec5e773b9/en/book/book/8db.md) 
+* [UML Classes](https://github.com/XoopsDocs/modulebuilder-tutorial/tree/156ff4d4d9ddbb7c0debc9ad33712afec5e773b9/en/book/book/8uml.md) 
+
diff --git a/81db.md b/81db.md
@@ -0,0 +1,6 @@
+# DB Tables
+
+![](.gitbook/assets/db_modulebuilder.jpg)
+
+_Figure 8.1: View of the database tables_
+
diff --git a/82uml.md b/82uml.md
@@ -0,0 +1,26 @@
+# UML Classes
+
+![](.gitbook/assets/uml_output.png)
+
+_Figure 8.2: Overall view of the module_
+
+![](.gitbook/assets/admin.png)
+
+_Figure 8.2: Admin Classes_
+
+![](.gitbook/assets/cssadminstyles.png)
+
+_Figure 8.2: Various classes_
+
+![](.gitbook/assets/cssstyles.png)
+
+_Figure 8.2: CSS Styles_
+
+![](.gitbook/assets/templatesblocks.png)
+
+_Figure 8.2: Template Blocks_
+
+![](.gitbook/assets/userdefstyle.png)
+
+_Figure 8.2: UserDefstyle Classes_
+
diff --git a/9credits.md b/9credits.md
@@ -0,0 +1,10 @@
+# Module Credits
+
+This module was originally created by the TDM Team under the name TdmCreate.
+
+It was heavily modified by Timgno \([http://www.txmodxoops.org](http://www.txmodxoops.org)\)
+
+Currently it was updated by Goffy \(German Xoops\) and Mamba \([https://xoops.org](https://xoops.org)\),
+
+Included is code ideas for Logo Generator from Trabis \(Publisher module\) and Suin \(Koins module\)
+