Commit 8b0960b2 authored by Johan Cwiklinski's avatar Johan Cwiklinski

GLPi => GLPI

parent 620b0178
The GLPi developper documentation is released under the terms of
The GLPI developper documentation is released under the terms of
the Creative Commons BY-NC-ND 4.0 license
(Attribution-NonCommercial-NoDerivatives 4.0 International).
......
......@@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GLPiDeveloperDocumentation.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GLPIDeveloperDocumentation.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GLPiDeveloperDocumentation.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GLPIDeveloperDocumentation.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/GLPiDeveloperDocumentation"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GLPiDeveloperDocumentation"
@echo "# mkdir -p $$HOME/.local/share/devhelp/GLPIDeveloperDocumentation"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GLPIDeveloperDocumentation"
@echo "# devhelp"
epub:
......
# GLPi's developper documentation
# GLPI's developper documentation
[![Build Status](https://readthedocs.org/projects/glpi-developer-documentation/badge/?version=latest)](http://glpi-developer-documentation.readthedocs.io/en/latest/?badge=latest)
......
......@@ -115,9 +115,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GLPiDeveloperDocumentation.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GLPIDeveloperDocumentation.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GLPiDeveloperDocumentation.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GLPIDeveloperDocumentation.ghc
goto end
)
......
......@@ -10,7 +10,7 @@ Here is the process you must follow when you are reviewing a PR.
2. Check if unit tests are not failing,
3. Check if coding standards checks are not failing,
4. Review the code itself. It must follow :doc:`GLPi's coding standards <../codingstandards>`,
4. Review the code itself. It must follow :doc:`GLPI's coding standards <../codingstandards>`,
5. Using the Github review process, approve, request changes or just comment the PR,
* If some new methods are added, or if the request made important changes in the code, you should ask the developer to write some more unit tests
......
......@@ -144,7 +144,7 @@ Classes
Class names must be written in `CamelCase`:
GLPi do not use `PHP namespaces <http://php.net/manual/en/language.namespaces.php>`_ right now; so be carefull when creating new classes to take a name that does not exists yet.
GLPI do not use `PHP namespaces <http://php.net/manual/en/language.namespaces.php>`_ right now; so be carefull when creating new classes to take a name that does not exists yet.
.. code-block:: php
......@@ -154,7 +154,7 @@ GLPi do not use `PHP namespaces <http://php.net/manual/en/language.namespaces.ph
}
Note: even if GLPi does not use namespaces, some libs does, you will have to take care of that. You can also if you wish use namespaces for PHP objects call.
Note: even if GLPI does not use namespaces, some libs does, you will have to take care of that. You can also if you wish use namespaces for PHP objects call.
For example, the folloging code:
......@@ -316,7 +316,7 @@ Database queries
Checking standards
------------------
In order to check some stabdards are respected, we provide some custom `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules. From the GLPi directory, just run:
In order to check some stabdards are respected, we provide some custom `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules. From the GLPI directory, just run:
.. code-block:: bash
......
# -*- coding: utf-8 -*-
#
# GLPi Developer Documentation documentation build configuration file, created by
# GLPI Developer Documentation documentation build configuration file, created by
# sphinx-quickstart on Thu Sep 29 12:02:29 2016.
#
# This file is execfile()d with the current directory set to its
......@@ -53,7 +53,7 @@ source_suffix = ['.rst', '.md']
master_doc = 'index'
# General information about the project.
project = u'GLPi Developer Documentation'
project = u'GLPI Developer Documentation'
copyright = u'2016, Teclib\''
rst_epilog = """
......@@ -195,7 +195,7 @@ html_static_path = ['_static']
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'GLPiDeveloperDocumentationdoc'
htmlhelp_basename = 'GLPIDeveloperDocumentationdoc'
# -- Options for LaTeX output ---------------------------------------------
......@@ -215,7 +215,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'GLPiDeveloperDocumentation.tex', u'GLPi Developer Documentation Documentation',
('index', 'GLPIDeveloperDocumentation.tex', u'GLPI Developer Documentation Documentation',
u'Teclib\'', 'manual'),
]
......@@ -245,7 +245,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'glpideveloperdocumentation', u'GLPi Developer Documentation Documentation',
('index', 'glpideveloperdocumentation', u'GLPI Developer Documentation Documentation',
[u'Teclib\''], 1)
]
......@@ -259,8 +259,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'GLPiDeveloperDocumentation', u'GLPi Developer Documentation Documentation',
u'Teclib\'', 'GLPiDeveloperDocumentation', 'One line description of project.',
('index', 'GLPIDeveloperDocumentation', u'GLPI Developer Documentation Documentation',
u'Teclib\'', 'GLPIDeveloperDocumentation', 'One line description of project.',
'Miscellaneous'),
]
......
.. GLPi Developer Documentation documentation master file, created by
.. GLPI Developer Documentation documentation master file, created by
sphinx-quickstart on Thu Sep 29 12:02:29 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
GLPi Developer Documentation
GLPI Developer Documentation
============================
.. image:: /_static/images/glpi.png
:alt: GLPi
:alt: GLPI
:align: center
.. toctree::
......
......@@ -3,7 +3,7 @@
Plugins
=======
GLPi provides facilities to develop plugins, and there are many `plugins that have been already published <plugins_dir_website_>`_.
GLPI provides facilities to develop plugins, and there are many `plugins that have been already published <plugins_dir_website_>`_.
Generally speaking, there is really a few things you have to do in order to get a plugin working; many considerations are up to you. Anyways, this guide will provide you some guidelines to get a plugins repository as consistent as possible :)
......@@ -14,17 +14,17 @@ If you want to see more advanced examples of what it is possible to do with plug
Requirements
------------
* plugin will be installed by creating a directory in the ``plugins`` directory of the GLPi instance,
* plugin will be installed by creating a directory in the ``plugins`` directory of the GLPI instance,
* plugin directory name should never change,
* each plugin **must** at least provides :ref:`setup.php <plugins_setupphp>` and :ref:`hook.php <plugins_hookphp>` files,
* if your plugin requires a newer PHP version than GLPi one, or extensions that are not mandatory in core; it is up to you to check that in the install process.
* if your plugin requires a newer PHP version than GLPI one, or extensions that are not mandatory in core; it is up to you to check that in the install process.
.. _plugins_setupphp:
setup.php
^^^^^^^^^
The plugin's `setup.php` file will be automatically loaded from GLPi's core in order to get its version, to check pre-requisites, etc.
The plugin's `setup.php` file will be automatically loaded from GLPI's core in order to get its version, to check pre-requisites, etc.
This is a good practice, thus not mandatory, to define a constant name `{PLUGINNAME}_VERSION` in this file.
......@@ -99,7 +99,7 @@ This is a minimalist example, for a plugin named `myexample` (functions names wi
hook.php
^^^^^^^^
This file will contains hooks that GLPi may call under some user actions. Refer to core documentation to know more about available hooks.
This file will contains hooks that GLPI may call under some user actions. Refer to core documentation to know more about available hooks.
For instance, a plugin need both an install and an uninstall hook calls. Here is the minimal file:
......@@ -129,7 +129,7 @@ For instance, a plugin need both an install and an uninstall hook calls. Here is
Coding standards
^^^^^^^^^^^^^^^^
You must respect GLPi's :doc:`global coding standards <../codingstandards>`.
You must respect GLPI's :doc:`global coding standards <../codingstandards>`.
Guidelines
......@@ -195,6 +195,6 @@ Keep in mind it could help users to know what have been changed. To achieve this
Third party libraries
^^^^^^^^^^^^^^^^^^^^^
Just like GLPi, you shoul use the :ref:`composer tool to manage third party libraries <3rd_party_libs>` for your plugin.
Just like GLPI, you shoul use the :ref:`composer tool to manage third party libraries <3rd_party_libs>` for your plugin.
.. _plugins_dir_website: http://plugins.glpi-project.org/
Source Code management
======================
GLPi source code management is handled by `GIT <https://en.wikipedia.org/wiki/Git>`_ and hosted on `GitHub <https://github.com/glpi-project/glpi>`_.
GLPI source code management is handled by `GIT <https://en.wikipedia.org/wiki/Git>`_ and hosted on `GitHub <https://github.com/glpi-project/glpi>`_.
In order to contribute to the source code, you will have to know a few things about Git and the development model we follow.
......@@ -23,7 +23,7 @@ Those branches are created when any major version is released. At the time I wro
Testing
-------
Unfortunately, tests in GLPi are not numerous... But that's willing to change, and we'd like - as far as possible - that proposals contains unit tests for the bug/feature they're related.
Unfortunately, tests in GLPI are not numerous... But that's willing to change, and we'd like - as far as possible - that proposals contains unit tests for the bug/feature they're related.
Anyways, existing unit tests may never be broken, if you made a change that breaks something, check your code, or change the unit tests, but fix that! ;)
......@@ -56,7 +56,7 @@ Just work with a:
A directory named ``glpi`` will bre created where you've issued the clone.
Then - if you did not already - you will have to create a fork of the repository on your github account; using the `Fork` button from the `GLPi's Github page <https://github.com/glpi-project/glpi/>`_. This will take a few moments, and you will have a repository created, `{you user name}/glpi - forked from glpi-project/glpi`.
Then - if you did not already - you will have to create a fork of the repository on your github account; using the `Fork` button from the `GLPI's Github page <https://github.com/glpi-project/glpi/>`_. This will take a few moments, and you will have a repository created, `{you user name}/glpi - forked from glpi-project/glpi`.
Add your fork as a remote from the cloned directory:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment