Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcosBL committed Feb 19, 2025
0 parents commit 7332caf
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Valentino Pesce

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
45 changes: 45 additions & 0 deletions Plugin.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

namespace Kanboard\Plugin\VisibleDescription;

use Kanboard\Core\Plugin\Base;

class Plugin extends Base
{

public function initialize()
{
$this->template->hook->attach('template:board:private:task:after-title', 'VisibleDescription:board/task_description');
}

public function getPluginName()
{
return 'VisibleDescription';
}

public function getPluginDescription()
{
return t('Shows Task\'s description inside their cards in the Board view');
}

public function getPluginAuthor()
{
return 'MarcosBL';
}

public function getPluginVersion()
{
return '1.0';
}

public function getCompatibleVersion()
{
return '>=1.0.48';
}

public function getPluginHomepage()
{
return 'https://github.com/MarcosBL/VisibleDescription';
}

}
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Visible Description field for kanboard
Shows Task's description inside their cards in the Board view.

Adds class .description-inside-task to it so you can adjust visualization trought app CSS configuration.

Author
------------
- MarcosBL
- License MIT

Requirements
------------
Kanboard >= v1.0.48
Kanboard installed at a web server.
You can find the download at [kanboard.org](https://kanboard.org/)

Installation
------------
You have the choice between 3 methods:

1. Install the plugin from the Kanboard plugin manager in one click
2. Download the zip file and decompress everything under the directory `plugins/VisibleDescription`
3. Clone this repository into the folder `plugins/VisibleDescription`

Note: Plugin folder is case-sensitive.

### :star: If you like it, do not forget to give a star on GitHub!

:construction_worker: Any contribution will be highly appreciated
------------
Clone the repository:
```console
git clone https://github.com/MarcosBL/VisibleDescription.git
```
:bug: Reporting Issues
------------
Please [create an issue](https://github.com/MarcosBL/VisibleDescription/issues) for any bugs you've found.
4 changes: 4 additions & 0 deletions Template/board/task_description.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div class="markdown description-inside-task" style="font-size:0.8em">
<?= str_replace('href', 'target="_blank" href', $this->text->markdown($task['description'])) ?>
</div>

0 comments on commit 7332caf

Please sign in to comment.