Skip to content
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.

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

Missing API Docs #102

Open
xylomorph opened this issue Feb 13, 2023 · 7 comments
Open

Missing API Docs #102

xylomorph opened this issue Feb 13, 2023 · 7 comments

Comments

@xylomorph
Copy link

Dear freeplane team,

I am trying to do some scripting. Unfortunately, the API docs are not available any more. The link https://www.freeplane.org/doc/api/ in this documentation leads to nothing. Could you update these links?

@euu2021
Copy link
Contributor

euu2021 commented Feb 17, 2023

Currently, the doc is at: https://docs.freeplane.org/scripting/Scripting.html

@xylomorph
Copy link
Author

I got that. But these are not the API docs, which describe classes and their methods in more detail. According to the docs you refer to, there are supposed to be API docs since some links refer to them (e.g. the link Proxy.Node under https://docs.freeplane.org/scripting/Scripting.html#the-scripting-api). The problem is that these links lead to nothing.

@macmarrum
Copy link
Collaborator

The site https://www.freeplane.org/doc/api/ has been taken down as the API was outdated and because the docs are distributed with Freeplane. It can be opened from within Freeplane: Help->Freeplane API…

We need to clean up the documentation pages to reflect that.

@xylomorph
Copy link
Author

Thanks!

@bekoeppel
Copy link

The site https://www.freeplane.org/doc/api/ has been taken down as the API was outdated and because the docs are distributed with Freeplane. It can be opened from within Freeplane: Help->Freeplane API…

Thank you!

We need to clean up the documentation pages to reflect that.

Would it be possible to serve a different page than the generic 404, explaining where to find the API documentation? E.g. on https://www.freeplane.org/doc/api/org/freeplane/plugin/script/proxy/Proxy.html, instead of

An error has been encountered in accessing this page.

Show something like

The API docs have moved. You can access the latest API documentation directly in Freeplane under Help->Freeplane API…

@macmarrum
Copy link
Collaborator

I have made the Scripting API available on-line at https://docs.freeplane.org/api/ and updated the urls in pages of https://docs.freeplane.org/

@dpolivaev Could you please redirect from https://www.freeplane.org/docs/api/ to https://docs.freeplane.org/api/

@dpolivaev
Copy link
Member

Redirects added for https://www.freeplane.org/docs/api/ and https://www.freeplane.org/doc/api/

Redirect 307 /docs/api https://docs.freeplane.org/api
Redirect 307 /doc/api https://docs.freeplane.org/api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants