Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PetersSharp authored and PetersSharp committed Feb 27, 2017
1 parent 993e64a commit 1a95dce
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 12 deletions.
42 changes: 42 additions & 0 deletions DokuWikiConnector.sln
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@

Microsoft Visual Studio Solution File, Format Version 11.00
# Visual C# Express 2010
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "stDokuWikiConnector", "stExtLib\stDokuWikiConnector-dll\stDokuWikiConnector.csproj", "{6A270155-DE22-4BC5-B049-20DFAF61ED0A}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestDokuWikiConnector", "stTest\TestDokuWikiConnector\TestDokuWikiConnector.csproj", "{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Debug|Mixed Platforms = Debug|Mixed Platforms
Debug|x86 = Debug|x86
Release|Any CPU = Release|Any CPU
Release|Mixed Platforms = Release|Mixed Platforms
Release|x86 = Release|x86
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Debug|x86.ActiveCfg = Debug|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Release|Any CPU.Build.0 = Release|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Release|Mixed Platforms.Build.0 = Release|Any CPU
{6A270155-DE22-4BC5-B049-20DFAF61ED0A}.Release|x86.ActiveCfg = Release|Any CPU
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Debug|Any CPU.ActiveCfg = Debug|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Debug|Mixed Platforms.ActiveCfg = Debug|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Debug|Mixed Platforms.Build.0 = Debug|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Debug|x86.ActiveCfg = Debug|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Debug|x86.Build.0 = Debug|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Release|Any CPU.ActiveCfg = Release|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Release|Mixed Platforms.ActiveCfg = Release|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Release|Mixed Platforms.Build.0 = Release|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Release|x86.ActiveCfg = Release|x86
{646971E5-A681-4EDC-AE8A-33FB0B6CD55E}.Release|x86.Build.0 = Release|x86
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
EndGlobal
87 changes: 75 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,88 @@
# DocuWikiConnector
.NET DocuWiki Connector API
see [stCoCServer](https://github.com/PetersSharp/stCoCServer)
# DokuWikiConnector
[![Release](https://img.shields.io/github/release/PetersSharp/DokuWikiConnector.svg?style=flat)](https://github.com/PetersSharp/DokuWikiConnector/releases/latest)
[![Issues](https://img.shields.io/github/issues/PetersSharp/stCoCServer.svg?style=flat)](https://github.com/PetersSharp/stCoCServer/issues)
[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/PetersSharp/stCoCServer/blob/master/LICENSE)

DocuWikiConnector [source](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stExtLib/stDokuWikiConnector-dll)
####.NET RPC-XML DokuWiki Connector API & Auth manager

DocuWikiConnector [Test suite](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stTest/TestDokuWikiConnector)
this part of stCoCServer, see [stCoCServer](https://github.com/PetersSharp/stCoCServer)

DocuWikiConnector [Method Documentation](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stExtLib/stDokuWikiConnector-dll/Doc)
####Features:

####Example use:
* API .NET library allows to XML-RPC connect to remote DokuWiki.
* Support all DokuWiki API operations.
* Local DokuWiki file credential authenticate managements.

* DokuWikiConnector [source](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stExtLib/stDokuWikiConnector-dll)
* DokuWikiConnector [Test suite](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stTest/TestDokuWikiConnector)
* DokuWikiConnector [Method Documentation](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stExtLib/stDokuWikiConnector-dll/Doc)
* Plugins publish [dokuwiki.org](https://www.dokuwiki.org/plugins:stdokuwikiconnector?s[]=dokuwikiconnector)

####Example use stDokuWiki.Connector:

```csharp

using stDokuWikiConnector;
using stDokuWiki.Connector;
using stDokuWiki.Data;

xml = new RpcXml(TestProgram.dkwUrl, "clanquest", "clanquest");
var dokuList = xml.DokuPageList("wiki:") as stDokuWikiConnector.Data.XMLMethodPageList;
foreach (var items in dokuList.Params.Param.Value.Array)
RpcXml xml = new RpcXml("http://you-dokuwiki-url.org/", "userquest", "userquest");
XMLMethodPageList dokuList = xml.DokuPageList("wiki:") as XMLMethodPageList;
foreach (var items in dokuList.Params.Param.Value.Array.Data.Value)
{
// ...
foreach (var item in items.Struct.Member)
{
Console.WriteLine(
item.Name +
((string.IsNullOrWhiteSpace(item.Value.Int)) ? " " : " [" + item.Value.Int + "] ") +
((string.IsNullOrWhiteSpace(item.Value.String)) ? "" : item.Value.String)
);
}
}

```

####Example use stDokuWiki.AuthManager:

```csharp

using stDokuWiki.AuthManager
using stDokuWiki.Data;

DokuAuthManager dam;
try
{
dam = new DokuAuthManager("/path/to/dokuwiki/root/dir","mygroup");

List<DokuAuthUser> uadd = new List<DokuAuthUser>()
{
new DokuAuthUser() { Login = "userLogin1", Password = "pwd1234", Name = "Nikolas", Email = "Nikolas@nomail.com", Group = "personalGroup"},
new DokuAuthUser() { ... },
};
List<DokuAuthUser> udel = new List<DokuAuthUser>()
{
new DokuAuthUser() { Login = "userLogin2", Password = "pwd5678", Name = "Tim", Email = "Tim@nomail.com", Group = "allGroup"},
new DokuAuthUser() { ... },
};

dam.UserAdd(uadd);
dam.UserDelete(udel);
dam.AuthSave();

DokuAuthUser dau = dam.UserGet("Nikolas");
if (dau != null)
{
Console.WriteLine(
dau.Name + " : " + dau.Email
);
}
}
catch (RpcXmlException e)
{
Console.WriteLine("[" + e.errcode + "] " +e.Message); return;
}
catch (Exception e)
{
Console.WriteLine(e.Message); return;
}

```
1 change: 1 addition & 0 deletions stExtLib/stDokuWikiConnector-dll/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DokuWikiConnector [library source](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stExtLib/stDokuWikiConnector-dll)
1 change: 1 addition & 0 deletions stTest/TestDokuWikiConnector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DokuWikiConnector [Test suite source](https://github.com/PetersSharp/stCoCServer/tree/master/stCoCServer/stTest/TestDokuWikiConnector)

0 comments on commit 1a95dce

Please sign in to comment.