====== gitlabproject Plugin ======

---- plugin ----
description: Gitlab-Project display a Gitlab project inside DokuWiki
author     : Algorythm
email      : ttamalfor@gmail.com
type       : syntax
lastupdate : 2017-10-17
compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
depends    : 
conflicts  : 
similar    : 
tags       : git, gitlab, code, projects

downloadurl: https://github.com/algorys/gitlabproject/archive/master.zip
bugtracker : https://github.com/algorys/gitlabproject/issues
sourcerepo : https://github.com/algorys/gitlabproject/
donationurl: 

screenshot_img : https://s7.postimg.org/nix31ws9n/gitlabproject-preview.png
----

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Syntax =====

==== Default Syntax ====

<code php>
<gitlab project="<NAMESPACE>/<PROJECT_NAME>" />
</code>

  * ''NAMESPACE'' is the namespace of your project, typically the name of the user or group in which the project is located.
  * ''PROJECT_NAME'' is the name of project.

For e.g., if you have a project available at ''%%http://my-gitlab/foo/bar%%'', the syntax will be:

<code php>
<gitlab project="foo/bar" />
</code>

==== Override Server and Token ====

Inside the root of the plugin, you will have a JSON file called: server.json. Inside you can add other servers and their tokens, than the one defined in the plugin settings.

Just call it after by its name.

E.g.:

With the following json file:

<code json>
{
    "second": {
        "url": "http://my-second-gitlab.com",
        "api_token": "a1a1a1a1a1a11a1a"
    }
    "third": {
        "url": "http://my-third-gitlab.com",
        "api_token": "b2b2b2b2b2b222b2"
    }
}
</code>

Then, simply add the server parameter with the name you've defined:

<code php>
<gitlab server="second" project="foo/bar" />
</code>

==== Wrong project or server ====

If project or server is not available or does not exist, gitlabproject will display a message to warn the user. 

===== Configuration and Settings =====

You can configure Gitlab-Project in the Configuration Manager of Dokuwiki:

  * **server.default**: Set your default Gitlab url, without slash ending. You can override this setting in server.json file.
  * **token.default**: Fill your admin token. You can override this setting in server.json file.
  * **unwanted.users**: If you want plugin ignore some members of your projects, add them here, separated by commas.

Gitlab-Project will use these data as default.

===== Change Log =====

{{rss>https://github.com/algorys/gitlabproject/commits/master.atom 5 author date}}

===== Known Bugs and Issues =====

Please report your issue or your idea at [[https://github.com/algorys/gitlabproject/issues|Gitlab-Project]].

Please change V3 to V4 in ''gitlab.php'' this is the ERROR

   {"error":"API V3 is no longer supported. Use API V4 instead."}
Thanks.