Plugin is not working with [!include] directive

[hiroshi-maeda]

In our documentation build system we are using Honkit with your plugin.
We tried to use [!include] directive
The files we tested are as follows.

test.md

@startuml
!include test.pu
@enduml

test.pu

@startuml
interface List
List : int size()
List : void clear()
List <|.. ArrayList
@enduml

The generated svg resulted in an error.

I wonder if you still support this plugin and could fix this issue. Or could give us a tip how to fix it.

[vowstar]

I'm trying to reproduce, but it works.

My nodejs version is :

node -v
v14.15.0

npx honkit build
info: 6 plugins are installed 
info: 6 explicitly listed 
info: plugin "uml" is loaded
info: plugin "highlight" is loaded
info: plugin "search" is loaded
info: plugin "lunr" is loaded
info: plugin "fontsettings" is loaded
info: plugin "theme-default" is loaded
info: found 1 pages 
info: found 2 asset files 
warn: "book" property is deprecated, use "this" directly instead 
warn: "this.generator" property is deprecated, use "this.output.name" instead 
warn: "navigation" property is deprecated 
warn: "options" property is deprecated, use config.get(key) instead 
info: >> generation finished with success in 0.7s !

And all files looks OK.

README.md

```puml
@startuml
!include test/test.plantuml
@enduml
```

SUMMARY.md

# Summary

* [Introduction](README.md)

test/test.plantuml

@startuml
(A)->(B)
@enduml

My files in this attachments, including SUMMARY.md, README.md, book.json, _book and asserts.
build_success.zip

[vowstar]

c7bcc6b

In order to test this problem more rigorously, I added a test case just now to prove the correctness of the process.

The build result is passed, https://github.com/vowstar/gitbook-plugin-uml/runs/3193927482

  "node_js": [
    "12",
    "16",
    "lts/*"
  ]

It passd with nodejs 12, 16 and current LTS under travis CI.

https://app.travis-ci.com/github/vowstar/gitbook-plugin-uml/builds/234008372

✔ should correctly use external plantuml file specified by ```puml @startuml !include ... @enduml tag (5810ms)

[hiroshi-maeda]

Thanks for the quick reply.
Sure enough, I redid it with the minimum configuration and it worked.
However, it still doesn't work with the project that caused the error.
I will close this issue and open it again when I find the problem.

[hiroshi-maeda]

I know what the problem is.
At the top level of the project, there is no problem.
The error occurs when there are Markdown files under a directory.

dir/dir_test.md

# dir_test
```plantuml
@startuml
!include dir_test.plantuml
@enduml
```

dir/dir_test.plantuml

@startuml
(C)->(D)
@enduml

The generated svg resulted in an error.

This problem occurs when the Markdown file is located under a directory.

Note that if you replace the path in the [!include dir_test.plantuml] part of the dir_test.md file with an absolute path, the image will be generated normally.

[vowstar]

could you try

dir/dir_test.md
dir/dir_test.plantuml

```plantuml
@startuml
!include dir/dir_test.plantuml
@enduml
```

Because the plantuml have a search path root is gitbook document root, so a prefix dir needed.

[hiroshi-maeda]

Thanks for the quick reply.
I was indeed able to respond with what you said.
However, in my local environment, I am using the following to make it work.

• VSCode
  • Markdown All in One
• GraphViz

There, this path specification causes an error in the opposite direction.
So this is a specification of Honkit (GitBook) and there is nothing I can do about it.
Is there any way to fix this?

[vowstar]

Thanks for the quick reply.
I was indeed able to respond with what you said.
However, in my local environment, I am using the following to make it work.

• VSCode

  • Markdown All in One

• GraphViz

There, this path specification causes an error in the opposite direction.
So this is a specification of Honkit (GitBook) and there is nothing I can do about it.
Is there any way to fix this?

Thanks for your information, I understand what happend. This is a bug, I'm writing code and try to fix it.

[vowstar]

I've add code to support uml in nested dir, and refactor the test case to check it. e118058
Could you try v1.2.10? It may fixed this issue.

[hiroshi-maeda]

I apologize for the delay in getting back to you.

The problem I was having was solved (on Windows).
To be honest, it's not working on Linux, but I feel like that's a problem with my environment.
I want to make sure, so it will take some more time.

[vowstar]

e118058#diff-e727e4bdf3657fd1d798edcd6b099d6e092f8573cba266154583a746bba0f346R43-R47

            if (require("process").platform == 'win32') {
                config.include = includePath + ';' + cwdPath;
            } else {
                config.include = includePath + ':' + cwdPath;
            }

The only different between linux and windows is ":" or ";" in include path, i only tested on linux. Thank you for windows test result.

[hiroshi-maeda]

I figured out why it didn't work on Linux.

I am Japanese. Therefore, I use Japanese (multibyte characters) for directory names.
In that case, it does not work well. If you change it to single byte characters, it will work fine.
If the file name is in Japanese, it will work fine.

Example:
　docs/01_設計/設計書.md → NG
docs/01_design/document.md → OK
docs/01_design/設計書.md → OK

Is there any possible solution to this problem?