From 266ddedaef581291a47acaf9814b66193942555f Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Mon, 16 Dec 2019 23:19:45 +0000 Subject: [PATCH] Update website --- docs/api/index.html | 2 +- docs/changelog/index.html | 2 +- docs/changelog_cli/index.html | 2 +- docs/clipper/index.html | 2 +- docs/debugging/index.html | 2 +- docs/desktop/index.html | 2 +- docs/donate/index.html | 2 +- docs/e2ee/index.html | 2 +- docs/faq/index.html | 2 +- docs/gsoc/idea1_nextcloud.html | 409 ---------------- docs/gsoc/idea2_sharing.html | 386 --------------- docs/gsoc/idea3_tagging.html | 386 --------------- docs/gsoc/idea4_search.html | 377 --------------- docs/gsoc/idea5_password_per_note.html | 382 --------------- docs/gsoc/idea_collaboration.html | 390 --------------- docs/gsoc/idea_hierarchical_tags.html | 382 --------------- docs/gsoc/idea_mobile_sharing.html | 388 --------------- docs/gsoc/idea_multi_profiles.html | 444 ------------------ docs/gsoc/idea_nextcloud.html | 397 ---------------- docs/gsoc/idea_ocr.html | 440 ----------------- .../idea_search.html => gsoc2020/ideas.html} | 88 +++- docs/{gsoc => gsoc2020}/index.html | 54 +-- docs/index.html | 2 +- docs/markdown/index.html | 2 +- docs/mobile/index.html | 2 +- docs/nextcloud_app/index.html | 2 +- docs/prereleases/index.html | 2 +- docs/spec/index.html | 2 +- docs/stats/index.html | 2 +- docs/terminal/index.html | 2 +- 30 files changed, 119 insertions(+), 4438 deletions(-) delete mode 100644 docs/gsoc/idea1_nextcloud.html delete mode 100644 docs/gsoc/idea2_sharing.html delete mode 100644 docs/gsoc/idea3_tagging.html delete mode 100644 docs/gsoc/idea4_search.html delete mode 100644 docs/gsoc/idea5_password_per_note.html delete mode 100644 docs/gsoc/idea_collaboration.html delete mode 100644 docs/gsoc/idea_hierarchical_tags.html delete mode 100644 docs/gsoc/idea_mobile_sharing.html delete mode 100644 docs/gsoc/idea_multi_profiles.html delete mode 100644 docs/gsoc/idea_nextcloud.html delete mode 100644 docs/gsoc/idea_ocr.html rename docs/{gsoc/idea_search.html => gsoc2020/ideas.html} (51%) rename docs/{gsoc => gsoc2020}/index.html (85%) diff --git a/docs/api/index.html b/docs/api/index.html index 9e95dbb8bd..aae0ffdfa5 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -286,7 +286,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api.md
  • Forum
  • Menu
    • -
  • GSoC 2020
    • +
  • GSoC 2020
    • - - - GSoC: Idea 1: Nextcloud | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Nextcloud notes integration (Web client)๐Ÿ”—

    -

    What is the goal of the project๐Ÿ”—

    -

    There is the community's wish to have the notes integrated Nextcloud, so that Notes can be sought by Nextcloud itsself. Although this idea focuses on Nextcloud it shall allow to extend it to other collaboration applications going beyond the current scope of Synchronisation.

    -

    There is already the web application what may can be integrated in collaboration application

    -

    what shall be answered in the application๐Ÿ”—

    -

    Why shall this idea be realized๐Ÿ”—

    -

    Allowing broader use of the application and better integration of the existing open source world, we don't want to invent the wheel twice

    -

    Who is talking about it๐Ÿ”—

    -

    The idea is outcome of (but not limited to) of some discussion taking place in the Forum and on GitHub:

    - -
    -

    COMMENTS:

    -
      -
    1. -

      โ€œNextcloud notes integration (Web client)โ€ is not well defined. What would be nice is a built-in Nextcloud web client for Joplin. But the top post in there is about something else that wonโ€™t be changed (explained in the FAQ: https://joplinapp.org/faq/#is-it-possible-to-use-real-file-and-folder-names-in-the-sync-target)

      -
      2. -
    2. -

      That would be interesting to know what they think about such an integration and how they see it because itโ€™s an old subject, we (the staff) are periodically debating:

      - -

      I imagined they just need a joplin-api in PHP and โ€œplugโ€ it on the right datasource to switch between โ€œNextcloud native note/Qownoteโ€ to Nextcloud/Qownnote โ€œJoplin noteโ€.

      -
      3. -
    3. -

      โ€œHow is WebDAV sync implemented?โ€ appears twice. It should only be in Summer of Doc.

      -
      4. -
    - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea2_sharing.html b/docs/gsoc/idea2_sharing.html deleted file mode 100644 index 77091bd826..0000000000 --- a/docs/gsoc/idea2_sharing.html +++ /dev/null @@ -1,386 +0,0 @@ - - - - - - - GSoC: Idea 2: Sharing | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Sharing๐Ÿ”—

    - -

    "Please give the ability to share from another Android app into Joplin": This is already done

    - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea3_tagging.html b/docs/gsoc/idea3_tagging.html deleted file mode 100644 index 4f146bc754..0000000000 --- a/docs/gsoc/idea3_tagging.html +++ /dev/null @@ -1,386 +0,0 @@ - - - - - - - GSoC: Idea 3: Tagging | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Tag handling๐Ÿ”—

    - -

    โ€œ[Feature Request] Tags on whole markdown lines #1498โ€: I prefer we remove this as this too far from standard markdown.

    -

    โ€œFeature request: set @tags from markdown editor #1407โ€. I prefer if we remove this too for the same reason. I think tagging is already easy since thereโ€™s a keyboard shortcut for it. Maybe back then there wasnโ€™t.

    -

    โ€œSo many tags #1221โ€: Was a bug, which has been fixed.

    - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea4_search.html b/docs/gsoc/idea4_search.html deleted file mode 100644 index aeb01e5134..0000000000 --- a/docs/gsoc/idea4_search.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - GSoC: Idea 4: Search | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Search engine improvements๐Ÿ”—

    -

    Search engine improvements

    - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea5_password_per_note.html b/docs/gsoc/idea5_password_per_note.html deleted file mode 100644 index 0088e48323..0000000000 --- a/docs/gsoc/idea5_password_per_note.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - GSoC: Idea 5: Password per Note | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Additinal protection per note๐Ÿ”—

    - -

    Password or pin protection: Itโ€™s very unclear what people want. It seems the threat model is you give your unlocked phone or laptop to someone, and you donโ€™t want them to see your notes. But of course, the solution is to not do that. All devices these days support multiple accounts, so thereโ€™s no point giving their unlocked device to someone they donโ€™t trust. I think we should remove this issue until itโ€™s betted defined. Perhaps it should go to a different category like, โ€œto be specifiedโ€. We need to know whatโ€™s the threat model, what people want. Iโ€™ve heard dozens of variations (locking the app, obfuscating the data, encrypting the data, encrypting a note, a notebook, encrypting a part of a note, etc.) so itโ€™s unclear what needs to be done. I guess for me it seems so unnecessary that I canโ€™t quite wrap my head around it.

    - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea_collaboration.html b/docs/gsoc/idea_collaboration.html deleted file mode 100644 index 486e1e747e..0000000000 --- a/docs/gsoc/idea_collaboration.html +++ /dev/null @@ -1,390 +0,0 @@ - - - - - - - GSoC: Idea: Collaboration | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Collaboration๐Ÿ”—

    -

    We need a way to share notes with other users, or publicly, and to collaborate on notes with other users. This is useful for companies, to collaborate on projects for example, but also for individual users when they want to share their notes with other people.

    -

    The basis for this would be the Joplin Web API for Nextcloud, which is currently used to share a note publicly, and which can be extended for other uses. There is a discussion thread about it in the forum.

    -

    Features๐Ÿ”—

    -

    The features we are looking to implement are:

    -
      -
    • Sharing a note publicly and allow the people you shared the link with to edit it.
      • -
    • Share a notebook publicly.
      • -
    • Share a note or notebook with the given Nextcloud user.
      • -
    -

    For now, we limit the scope to Nextcloud but later the Nextcloud app (which is essentially a PHP app) could be extracted and made to work with other backends.

    -

    See also๐Ÿ”—

    - - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea_hierarchical_tags.html b/docs/gsoc/idea_hierarchical_tags.html deleted file mode 100644 index a6266825a6..0000000000 --- a/docs/gsoc/idea_hierarchical_tags.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - GSoC: Idea: Hiearchical Tags | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Hierarchical Tags๐Ÿ”—

    -

    One of the most asked-for feature in Joplin is support for hierarchical tags. This would allow users that heavily rely on tags to organise them into a hierarchy, as is done for the notebooks.

    -

    The feature would need to be implemented for the three clients (Desktop, Mobile, Terminal).

    -

    See also๐Ÿ”—

    - - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea_mobile_sharing.html b/docs/gsoc/idea_mobile_sharing.html deleted file mode 100644 index 9f78e92866..0000000000 --- a/docs/gsoc/idea_mobile_sharing.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - GSoC: Idea: Mobile Sharing | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Sharing on Mobile๐Ÿ”—

    -

    The mobile application allows sharing text from any application to Joplin. However it is not currently possible to share images or to share selected text with Joplin.

    -

    Features๐Ÿ”—

    -
      -
    • Allow sharing an image or file from any application to Joplin
      • -
    • Allow selecting some text in an application (in a browser for instance) and share it with Joplin
      • -
    -

    See also๐Ÿ”—

    - - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea_multi_profiles.html b/docs/gsoc/idea_multi_profiles.html deleted file mode 100644 index 1ebcb3c724..0000000000 --- a/docs/gsoc/idea_multi_profiles.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - - GSoC: Idea: Multi-Profile Support | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Support for multiple profiles๐Ÿ”—

    -

    The applications should support multiple profiles so that, for example, one can have a "work" profile and "personal" profile. This will also make it easier to share notes because for example a "work project" profile could be created and share with co-workers.

    -

    Specification๐Ÿ”—

    -

    Provide a way to switch profiles from the app:

    -
      -
    • The user clicks on a menu and select change profile
      • -
    • The list of available profiles is displayed
      • -
    • User selects on of the profile
      • -
    • The app closes and re-open and load the selected profile
      • -
    -

    Changing the structure of the profile directory๐Ÿ”—

    -

    The structure of the profile directory needs to be changed for this to work.

    -

    Currently, the profile is organised like this:

    -
      -
    • ~/.config/joplin-desktop/ -
        -
      • resources/
        • -
      • database.sqlite
        • -
      -
      • -
    -

    If we want to support multiple profiles, the config directory should be changed like so (in a way similar to Firefox or Thunderbird multi-profile support):

    -
      -
    • ~/.config/joplin-desktop/ -
        -
      • PROFILE_ID_1/
        • -
      • PROFILE_ID_2/
        • -
      • etc.
        • -
      • profile.ini
        • -
      -
      • -
    -

    The PROFILE_ID_x directories will be named with a UUID and contain the same profile as above with the "resources" and "database.sqlite" file.

    -

    profile.ini will tell what profiles are available. It's content will be like this (same as Firefox):

    -
    [Profile1]
-Name=Personal
-IsRelative=1
-Path=cdb4ar19.Personal
-
-[Profile0]
-Name=default
-IsRelative=1
-Path=Profiles/ts6eud8o.default
-Default=1
-
-[Profile2]
-Name=Work
-IsRelative=1
-Path=Profiles/ts9akd8o.work
-
-[General]
-StartWithLastProfile=1
-Version=1
-
    -

    Since the profile directory is changed, there should be a migration step that will convert old profiles to the new structure when the app starts.

    -

    Switching profiles๐Ÿ”—

    -

    To switch profile, save a value to the Settings called "next_profile_id", then close and restart the app. When the app starts it loads "profile.ini", then checks the value of "next_profile_id", and uses that to choose and load the right profile.

    -

    Locking per profile๐Ÿ”—

    -

    Each app needs to make sure that a given profile can only be open by one application, so there should be form of lock. If a profile is locked, it means it's already opened by another application, so the current application should close.

    -

    Locking should be implemented in such a way that if an app crashes, the lock is released. So probably some form of in-memory lock.

    -

    Desktop implementation๐Ÿ”—

    -

    To restart the app use the built-in Electron function: https://electronjs.org/docs/api/app#apprelaunchoptions

    -

    Mobile implementation๐Ÿ”—

    -

    On mobile, give a try to this package to restart the app: https://www.npmjs.com/package/react-native-restart

    -

    See also๐Ÿ”—

    - - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea_nextcloud.html b/docs/gsoc/idea_nextcloud.html deleted file mode 100644 index 9370570d37..0000000000 --- a/docs/gsoc/idea_nextcloud.html +++ /dev/null @@ -1,397 +0,0 @@ - - - - - - - GSoC: Idea: Nextcloud | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: Nextcloud notes integration (Web client)๐Ÿ”—

    -

    What is the goal of the project๐Ÿ”—

    -

    There is the community's wish to have the notes integrated Nextcloud, so that Notes can be sought by Nextcloud itsself. Although this idea focuses on Nextcloud it shall allow to extend it to other collaboration applications going beyond the current scope of Synchronisation.

    -

    There is already the web application what may can be integrated in collaboration application.

    -

    There is also a Joplin Web API for Nextcloud, which is currently used to share a note publicly, and which could be extended to other uses. There is a discussion thread about it in the forum.

    -

    Features๐Ÿ”—

    -

    Feature parity with the desktop client is not needed and would be out of scope.

    -

    These are the features that would be needed to create a minimal web client:

    -
      -
    • Ability to list the notebooks in a hierarchy
      • -
    • Ability to view a note and render the Markdown to HTML
      • -
    • Ability to edit the Markdown note and save it
      • -
    • Handle conflicts when, for example, a note is modified in the web client and, at the same time, it is modified via sync.
      • -
    -

    Who is talking about it๐Ÿ”—

    -

    The idea is outcome of (but not limited to) of some discussion taking place in the Forum and on GitHub:

    - - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea_ocr.html b/docs/gsoc/idea_ocr.html deleted file mode 100644 index 924ea9f052..0000000000 --- a/docs/gsoc/idea_ocr.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - - - - GSoC: Idea: OCR Support | Joplin - - - - - - - - - - - - - -
    - -
    - -

    Joplin

     -

    An open source note taking and to-do application with synchronisation capabilities

    -
    - -
    -
    - -
    - - -
    -
    -
    - -
    - -

    GSoC: OCR๐Ÿ”—

    -

    It seems possible to add support for OCR content in Joplin via the [http://tesseract.projectnaptha.com/](Tesseract library).

    -

    A first step would be to assess the feasability of this project by integrating the lib in the desktop app and trying to OCR an image.

    -
      -
    • Is the image correctly OCRed?
      • -
    • Does it work with non-English text?
      • -
    • How slow/fast is it? Test with a very large image to be sure. It should not freeze the app while processing an image.
      • -
    -

    If everything works well, we can add the feature to the app.

    -

    Specification๐Ÿ”—

    -
      -
    • On desktop app: Create service that runs in the background and process the resources that need to be OCRed.
      • -
    • When a document is OCRed: Append block to end of note that contains the extracted plain text
      • -
    • When attaching resource, ask what user wants to do: -
        -
      • Always OCR all files
        • -
      • Never OCR any file
        • -
      • Always OCR files with extension ".ext"
        • -
      • Never OCR files with extension ".ext"
        • -
      -
      • -
    • Can be changed in settings
      • -
    • Right-click resource, or note, to OCR content
      • -
    • Add resource ocr_status on resource table: Can be: none, todo, processing, done
      • -
    • Add ocr_text to resource: must include detailed coordinates, and a way to get plain text back
      • -
    -

    Advantage of it doing that way:

    -
      -
    • Search engine just works - no need for special indexing of OCR content since it is inside the note directly
      • -
    • Will work with all clients (mobile, desktop, terminal)
      • -
    • When a note is exported to Markdown, it will include the OCR content
      • -
    -

    Format of OCR text block

    -
    <!-- autogen-ocr :resource.id -->
-* * *
-
-**:resource.title**
-
-:resource.ocr_text
-<!-- autogen-ocr :resourceId -->
-
    -

    For example, for a resource called "TrainTicket.png":

    -
    <!-- autogen-ocr 2ee4eec909734f7197654a9a040dfba7 -->
-* * *
-
-**TrainTicket.png**
-
-From: London
-To: Paris
-Date: 01/12/2019
-Time: 15:00
-...etc.
-<!-- autogen-ocr :resourceId -->
-
    -

    The advantage of this format is that it will render nicely in the viewer, and it will still be clearly identified as OCR content, which means later we can identify these blocks, update them, remove them, etc.

    -

    Later

    -
      -
    • Support PDF files - for example by converting each page to an image first, then passing it to Tesseract.
      • -
    • Make ocr_text searchable
      • -
    • Display search results directly on document. i.e. if it's an image, highlight the parts of the image that contain the search text.
      • -
    -

    See also๐Ÿ”—

    - - -
    - - Improve this doc - -
    - - -
    -Copyright (c) 2016-2019 Laurent Cozic -
    - - diff --git a/docs/gsoc/idea_search.html b/docs/gsoc2020/ideas.html similarity index 51% rename from docs/gsoc/idea_search.html rename to docs/gsoc2020/ideas.html index a583e88f30..d4611c4e2c 100644 --- a/docs/gsoc/idea_search.html +++ b/docs/gsoc2020/ideas.html @@ -5,16 +5,16 @@ !!! WARNING !!! -This file was auto-generated from readme/gsoc/idea_search.md and any manual change +This file was auto-generated from readme/gsoc2020/ideas.md and any manual change made to it will be overwritten. To make a change to this file please modify the source Markdown file: -https://github.com/laurent22/joplin/blob/master/readme/gsoc/idea_search.md +https://github.com/laurent22/joplin/blob/master/readme/gsoc2020/ideas.md --> - GSoC: Idea: Search | Joplin + GSoC: Project Ideas | Joplin @@ -272,7 +272,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsoc/idea_search.md -
    +
    @@ -286,7 +286,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsoc/idea_search.md
  • Forum
  • Menu
    • -
  • GSoC 2020
    • +
  • GSoC 2020
    • @@ -286,7 +286,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsoc/index.md
  • Forum
  • Menu
    • -
  • GSoC 2020
    • +
  • GSoC 2020