Skip to content

Add wiki:<wiki_id> links in Kanboard #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
arturog wants to merge 3 commits into
base: dev
Choose a base branch
from
Draft

Add wiki:<wiki_id> links in Kanboard #115

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7470303
Add wiki:<wiki_id> links
arturog May 31, 2025
69e42b4
Make some Wiki changes to make it bearable
arturog Aug 19, 2025
2b9ebe5
Remove echoes
arturog Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Asset/css/wiki.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ body.dragging, body.dragging * {
resize: horizontal;
overflow: auto;
max-width: 75% !important;
min-width: 384px !important;
min-width: 180px !important;
}

.wikipage {
Expand Down
26 changes: 26 additions & 0 deletions Helper/MarkdownHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php

namespace Kanboard\Plugin\Wiki\Helper;

use Kanboard\Helper\TextHelper;
use ParsedownExtra;

class MarkdownHelper extends TextHelper
{
/**
* Markdown transformation
*
* @param string $text
* @param boolean $isPublicLink
* @return string
*/
public function markdown($text, $isPublicLink = false)
{
$parser = new WikiMarkdown($this->container, $isPublicLink);
$parser->setMarkupEscaped(MARKDOWN_ESCAPE_HTML);
$parser->setBreaksEnabled(true);
$parser->setContainer($this->container);

return $parser->text($text ?: '');
}
}
1 change: 0 additions & 1 deletion Helper/WikiHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
use Kanboard\Core\Base;
use Kanboard\Model\Wiki;


class WikiHelper extends Base
{
/**
Expand Down
50 changes: 50 additions & 0 deletions Helper/WikiMarkdown.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?php

namespace Kanboard\Plugin\Wiki\Helper;

use Kanboard\Core\Markdown;
use Kanboard\Helper\TextHelper;
use Kanboard\Helper\UrlHelper;

class WikiMarkdown extends Markdown
{
public function setContainer($container)
{
$this->container = $container;
}
protected function inlineLink($Excerpt)
{
$retval = parent::inlineLink($Excerpt);
if (!is_array($retval)) {
return $retval;
}

$href = $retval['element']['attributes']['href'];
if (!is_string($href))
{
return $retval;
}

echo $href;
if (!preg_match('!^wiki:(\d+)$!', $href, $matches))
{
echo "Hello";
return $retval;
}

$wiki_id = $matches[1];

$href = $this->container['helper']->url->to(
'WikiController',
'detail',
array(
'plugin' => 'wiki',
'wiki_id' => $wiki_id,
'project_id' => $this->container['helper']->url->request->getIntegerParam('project_id')
),
'wiki'
);
$retval['element']['attributes']['href'] = $href;
return $retval;
}
}
3 changes: 3 additions & 0 deletions Plugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ public function initialize()

// helpers
$this->helper->register('wikiHelper', '\Kanboard\Plugin\Wiki\Helper\WikiHelper');

// Add Markdown extras
$this->container['helper']->register('text', '\Kanboard\Plugin\Wiki\Helper\MarkdownHelper');
}

public function onStartup()
Expand Down
76 changes: 37 additions & 39 deletions Template/wiki/detail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,11 @@
'not_editable' => $not_editable,
)) ?>

<div class="sidebar-content">
<div class="sidebar-content" style="margin-left: 1em; padding-left: 1em; border-left: 1px solid black">
<div class="page-header">
<h2><?=t($wikipage['title'])?></h2>
<?php if (!$not_editable): ?>
<?=$this->modal->medium('edit', t('Edit page'), 'WikiController', 'edit', array('plugin' => 'wiki', 'wiki_id' => $wikipage['id']))?>
<?=$this->helper->modal->confirm('trash-o', t('Remove page'), 'WikiController', 'confirm', array('plugin' => 'wiki', 'project_id' => $project['id'], 'wiki_id' => $wikipage['id']))?>
<button class="separator">&nbsp;&nbsp;&nbsp;&nbsp;</button>
<?=$this->url->icon('window-restore', t('View Editions'), 'WikiController', 'editions', array('plugin' => 'wiki', 'project_id' => $project['id'], 'wiki_id' => $wikipage['id']))?>
<?php endif ?>
<?php if(isset($wikipage['parent_id'])): ?>
Expand All @@ -34,6 +32,42 @@
<?php endif ?>
</div>

<div class="wikicontent">
<div class="page-header">
<h2><?=t($wikipage['title'])?></h2>
Copy link

@accesslint accesslint bot Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Headings shouldn't be empty.

</div>
<?php if (!empty($wikipage['content'])): ?>
<article class="markdown">
<?=$this->text->markdown($wikipage['content'])?>
</article>
<?php endif?>

<?php if (!$not_editable): ?>
<div class="page-header" style="margin-top: 5em;">
<h2><?=t('Attachments')?></h2>
Copy link

@accesslint accesslint bot Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Headings shouldn't be empty.

</div>
<ul>
<?php
ini_set('display_errors', 1);
ini_set('display_startup_errors', 1);
error_reporting(E_ALL);
?>
<?=$this->modal->medium('file', t('Attach a document'), 'WikiFileController', 'create', array('plugin' => 'wiki', 'wiki_id' => $wikipage['id'], 'project_id' => $wikipage['project_id']))?>
<?= $this->modal->medium('camera', t('Add a screenshot'), 'WikiFileController', 'screenshot', array('plugin' => 'wiki', 'wiki_id' => $wikipage['id'], 'project_id' => $wikipage['project_id'])) ?>
</ul>

<?php if (!empty($files) || !empty($images)): ?>
<?= $this->hook->render('template:task:show:before-attachments', array('wiki' => $wiki, 'project' => $project)) ?>
<?= $this->render('wiki:wiki_file/show', array(
'wiki' => $wiki,
'files' => $files,
'images' => $images
)) ?>
<?php endif ?>
<?php endif ?>

<hr style="margin-top: 2em; margin-bottom: 2em;" />

<div style="float:left">
<ul class="panel" style="margin:0">
<details open>
Expand All @@ -51,8 +85,6 @@
</ul>
</div>

<div style="float:left">&nbsp;&nbsp;&nbsp;</div>

<div class="sidebar" style="float:left;max-width:100%;padding:0">
<ul class="panel" style="margin:0">
<details open>
Expand All @@ -78,40 +110,6 @@
</ul>
</div>

<div class="wikicontent">
<br>
<?php if (!empty($wikipage['content'])): ?>
<div class="page-header">
<h2><?=t('Content')?></h2>
</div>
<article class="markdown">
<?=$this->text->markdown($wikipage['content'])?>
</article>
<?php endif?>

<?php if (!$not_editable): ?>
<div class="page-header">
<h2><?=t('Attachments')?></h2>
</div>
<ul>
<?php
ini_set('display_errors', 1);
ini_set('display_startup_errors', 1);
error_reporting(E_ALL);
?>
<?=$this->modal->medium('file', t('Attach a document'), 'WikiFileController', 'create', array('plugin' => 'wiki', 'wiki_id' => $wikipage['id'], 'project_id' => $wikipage['project_id']))?>
<?= $this->modal->medium('camera', t('Add a screenshot'), 'WikiFileController', 'screenshot', array('plugin' => 'wiki', 'wiki_id' => $wikipage['id'], 'project_id' => $wikipage['project_id'])) ?>
</ul>

<?php if (!empty($files) || !empty($images)): ?>
<?= $this->hook->render('template:task:show:before-attachments', array('wiki' => $wiki, 'project' => $project)) ?>
<?= $this->render('wiki:wiki_file/show', array(
'wiki' => $wiki,
'files' => $files,
'images' => $images
)) ?>
<?php endif ?>
<?php endif ?>

</div>

Expand Down
8 changes: 4 additions & 4 deletions Template/wiki/sidebar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@
<br>
<h2><?= t('Wiki') ?> <?= t('Content') ?></h2>
<div style="float: right">
<button class="gotoSelected actionBigger" title="<?= t('Go to Selected Wiki Page') ?>"><a><i class="fa fa-share-square"></i></a></button>
<button class="expandAll actionBigger"title="<?= t('Expand All Wiki Subpages') ?>"><a><i class="fa fa-plus-square"></i></a></button>
<button class="collapseAll actionBigger"title="<?= t('Collapse All Wiki Subpages') ?>"><a><i class="fa fa-minus-square"></i></a></button>
<button class="gotoSelected" title="<?= t('Go to Selected Wiki Page') ?>"><a><i class="fa fa-share-square"></i></a></button>
<button class="expandAll"title="<?= t('Expand All Wiki Subpages') ?>"><a><i class="fa fa-plus-square"></i></a></button>
<button class="collapseAll"title="<?= t('Collapse All Wiki Subpages') ?>"><a><i class="fa fa-minus-square"></i></a></button>
</div>
</div>
<br>

<?php if (!empty($wikipages)): ?>
<ul id="wikitree" data-selected-wiki-id="<?=$wiki_id?>" <?php if (!$not_editable): ?>data-reorder-url="<?= $this->url->href('WikiAjaxController', 'reorder_by_index', array('plugin' => 'wiki', 'project_id' => $project['id'], 'csrf_token' => $this->app->getToken()->getReusableCSRFToken())) ?>"<?php endif ?>>
<li class="wikipage<?=$is_active?>" data-project-id="<?= $project['id'] ?>" data-page-id="0" data-page-order="0">
<button class="branch actionBigger" title="' . t('Expand/Collapse Subpages') . '"><a><i class="fa fa-minus-square-o"></i></a></button>
<button class="branch" title="' . t('Expand/Collapse Subpages') . '"><a><i class="fa fa-minus-square-o"></i></a></button>
<?php if (!$not_editable): ?>
<?=$this->helper->url->icon('home', t('(root)'), 'WikiController', 'detail', array('plugin' => 'wiki', 'project_id' => $project['id'], 'wiki_id' => 0), false, 'wikilink'.$is_active)?>
<?php else: ?>
Expand Down
Loading