Merge pull request #166 from alefragnani/features/support-getting-sta…

…rted

Add Walkthrough / Getting Started support

package.json

@@ -482,7 +482,56 @@
                     "group": "numberedBookmarks@10"
                 }
             ]
-        }
+        },
+        "walkthroughs": [
+            {
+                "id": "numberedBookmarksWelcome",
+                "title": "%numberedBookmarks.walkthroughs.title%",
+                "description": "%numberedBookmarks.walkthroughs.description%",
+                "steps": [
+                    {
+                        "id": "toggle",
+                        "title": "%numberedBookmarks.walkthroughs.toggle.title%",
+                        "description": "%numberedBookmarks.walkthroughs.toggle.description%",
+                        "media": {
+                            "markdown": "walkthrough/toggle.md"
+                        }
+                    },
+                    {
+                        "id": "navigateToNumberedBookmarks",
+                        "title": "%numberedBookmarks.walkthroughs.navigateToNumberedBookmarks.title%",
+                        "description": "%numberedBookmarks.walkthroughs.navigateToNumberedBookmarks.description%",
+                        "media": {
+                            "markdown": "walkthrough/navigateToNumberedBookmarks.md"
+                        }
+                    },
+                    {
+                        "id": "inspiredInDelphiButOpenToOthers",
+                        "title": "%numberedBookmarks.walkthroughs.inspiredInDelphiButOpenToOthers.title%",
+                        "description": "%numberedBookmarks.walkthroughs.inspiredInDelphiButOpenToOthers.description%",
+                        "media": {
+                            "markdown": "walkthrough/inspiredInDelphiButOpenToOthers.md"
+                        }
+                    },
+                    {
+                        "id": "workingWithRemotes",
+                        "title": "%numberedBookmarks.walkthroughs.workingWithRemotes.title%",
+                        "description": "%numberedBookmarks.walkthroughs.workingWithRemotes.description%",
+                        "media": {
+                            "markdown": "walkthrough/workingWithRemotes.md"
+                        }
+                    },
+                    {
+                        "id": "customizingAppearance",
+                        "title": "%numberedBookmarks.walkthroughs.customizingAppearance.title%",
+                        "description": "%numberedBookmarks.walkthroughs.customizingAppearance.description%",
+                        "media": {
+                            "markdown": "walkthrough/customizingAppearance.md"
+                        }
+                    }
+                ]
+            }
+        ]
     },
     "eslintConfig": {
         "extends": [

package.nls.json

@@ -37,5 +37,18 @@
     "numberedBookmarks.configuration.gutterIconNumberColor.description": "Specify the color to use on gutter icon (number color)",
     "numberedBookmarks.colors.lineBackground.description": "Background color for the bookmarked line",
     "numberedBookmarks.colors.lineBorder.description": "Background color for the border around the bookmarked line",
-    "numberedBookmarks.colors.overviewRuler.description": "Overview ruler marker color for bookmarks"
+    "numberedBookmarks.colors.overviewRuler.description": "Overview ruler marker color for bookmarks",
+    "numberedBookmarks.walkthroughs.title": "Get Started with Numbered Bookmarks",
+    "numberedBookmarks.walkthroughs.description": "Learn more about Numbered Bookmarks to optimize your workflow",
+    "numberedBookmarks.walkthroughs.toggle.title": "Toggle Numbered Bookmarks",
+    "numberedBookmarks.walkthroughs.toggle.description": "Easily Mark/Unmark Numbered Bookmarks at any position.\nAn icon is added to both the gutter and overview ruler to easily identify the lines with Numbered Bookmarks.",
+    "numberedBookmarks.walkthroughs.navigateToNumberedBookmarks.title": "Navigate to Numbered Bookmarks",
+    "numberedBookmarks.walkthroughs.navigateToNumberedBookmarks.description": "Quickly jump between bookmarked lines.\nSearch numbered bookmarks using the line's content and/or position.",
+    "numberedBookmarks.walkthroughs.inspiredInDelphiButOpenToOthers.title": "Inspired in Delphi, but open to others",
+    "numberedBookmarks.walkthroughs.inspiredInDelphiButOpenToOthers.description": "The extension was inspired in Delphi, because I was a Delphi developer for a long time, and love it's bookmarks, but it supports different editors as well.",
+    "numberedBookmarks.walkthroughs.workingWithRemotes.title": "Working with Remotes",
+    "numberedBookmarks.walkthroughs.workingWithRemotes.description": "The extension support [Remote Development](https://code.visualstudio.com/docs/remote/remote-overview) scenarios. Even installed locally, you can use Numbered Bookmarks in WSL, Containers, SSH and Codespaces.",
+    "numberedBookmarks.walkthroughs.customizingAppearance.title": "Customizing Appearance",
+    "numberedBookmarks.walkthroughs.customizingAppearance.description": "Customize how Numbered Bookmarks are presented, its icon, line and overview ruler\n[Open Settings - Gutter Icon](command:workbench.action.openSettings?%5B%22numberedBookmarks.gutterIcon%22%5D)\n[Open Settings - Line](command:workbench.action.openSettingsJson?%5B%22workbench.colorCustomizations%22%5D)"
+
 }

walkthrough/customizingAppearance.md

@@ -0,0 +1,20 @@
+## Customizing Appearance
+
+You can customize not only how the icon is show in the Gutter, but also add a background color to the bookmarked line and the overview ruller.
+
+Something like this in your settings:
+
+```json
+    "numberedBookmarks.gutterIconFillColor": "#00FF0077",
+    // "numberedBookmarks.gutterIconNumberColor": "157EFB",
+    "workbench.colorCustomizations": {
+      ...
+      "numberedBookmarks.lineBackground": "#0077ff2a",
+      "numberedBookmarks.lineBorder": "#FF0000", 
+      "numberedBookmarks.overviewRuler": "#157EFB88"  
+    }
+```
+
+Could end up with a numbered bookmark like this:
+
+![Customized Numbered Bookmark](customizedNumberedBookmark.png)

walkthrough/customizingAppearance.nls.pt-br.md

@@ -0,0 +1,20 @@
+## Personalizando a Aparência
+
+Você pode personalizar não apenas como o ícone é apresentado na Medianiz, mas também adicionar cor de fundo a linha com bookmark e a régua de visão geral.
+
+Algo como isso nas suas configuráções:
+
+```json
+    "numberedBookmarks.gutterIconFillColor": "#00FF0077",
+    // "numberedBookmarks.gutterIconNumberColor": "157EFB",
+    "workbench.colorCustomizations": {
+      ...
+      "numberedBookmarks.lineBackground": "#0077ff2a",
+      "numberedBookmarks.lineBorder": "#FF0000", 
+      "numberedBookmarks.overviewRuler": "#157EFB88"  
+    }
+```
+
+Pode deixar seus bookmarks assim:
+
+![Numbered Bookmark Personalizado](customizedNumberedBookmark.png)

walkthrough/inspiredInDelphiButOpenToOthers.md

@@ -0,0 +1,25 @@
+## Inpired in Delphi, but open to others
+
+The extension was inspired in Delphi, because I was a Delphi developer for a long time, and love it's bookmarks. But it supports different editors as well.
+
+To change a bit how the extension works (toggling and navigation), simply play with the `numberedBookmarks.navigateThroughAllFiles` setting:
+
+Value | Explanation
+--------- | ---------
+`false` | _default_ - same behavior as today
+`replace` | you can't have the same numbered bookmark in different files
+`allowDuplicates` | you can have the same numbered bookmark in different files, and if you jump repeatedly to the same number, it will look on other files.
+
+### IntelliJ / UltraEdit developers
+
+If you are an **IntelliJ** or **UltraEdit** user, you will notice the numbered bookmarks works a bit different from the default behavior. 
+
+To make **Numbered Bookmarks** works the same way as these other tools, simply add `"numberedBookmarks.navigateThroughAllFiles": replace"` to your setting and you are good to go.
+
+<table align="center" width="85%" border="0">
+  <tr>
+    <td align="center">
+      <a title="Open Settings" href="command:workbench.action.openSettings?%5B%22numberedBookmarks.navigateThroughAllFiles%22%5D">Open Settings</a>
+    </td>
+  </tr>
+</table>

walkthrough/inspiredInDelphiButOpenToOthers.nls.pt-br.md

@@ -0,0 +1,25 @@
+## Inspirado no Delphi, mas aberto a outros
+
+A extensão foi inspirada no Delphi, pois eu fui um desenvolvedor Delphi por muito tempo, e adoro seus bookmarks. Mas ele suporta diferentes editores também. 
+
+Para mudar um pouco como a extensão funciona (alternar e navegar), basta brincar com a configuração `numberedBookmarks.navigateThroughAllFiles`:
+
+Valor | Explicação
+--------- | ---------
+`false` | _padrão_ - mesmo comportamento de hoje
+`replace` | você não pode ter o mesmo numbered bookmark em arquivos distintos
+`allowDuplicates` | você pode ter o mesmo numbered bookmark em arquivos distintos, e se você acionar repetidamente ao mesmo número, ele irá olhar para os outros arquivos.
+
+### Desenvolvedores IntelliJ / UltraEdit
+
+Se você é um usuário do **IntelliJ** ou **UltraEdit**, você vai notar que o numbered bookmarks funciona um pouco diferente do seu comportamento padrão.
+
+Para fazer **Numbered Bookmarks** funcionar do mesmo jeito dessas ferramentas, simplesmente adicione `"numberedBookmarks.navigateThroughAllFiles": replace"` nas suas configurações e aproveite.
+
+<table align="center" width="85%" border="0">
+  <tr>
+    <td align="center">
+      <a title="Abrir Configurações" href="command:workbench.action.openSettings?%5B%22numberedBookmarks.navigateThroughAllFiles%22%5D">Abrir Configurações</a>
+    </td>
+  </tr>
+</table>

walkthrough/navigateToNumberedBookmarks.md

@@ -0,0 +1,12 @@
+## Navigate to Numbered Bookmarks
+
+Bookmarks represent positions in your code, so you can easily and quickly go back to them whenever necessary. 
+
+The extension provides commands to quickly navigate every bookmark, from `Numbered Bookmarks: Jump to Bookmark 0` to  `Numbered Bookmarks: Jump to Bookmark 9`, with a keyboard shortcut for each one of it (<kbd>Ctrl</kbd> +  <kbd>#number</kbd>)
+
+But it is not limited to this. It also provides commands to see all Numbered Bookmarks within a file, or the entire workspace and easily go to it. Use the `Numbered Bookmarks: List` and `Numbered Bookmarks: List from All Files` command instead, and the extension will display a preview of the bookmarked line and it position. 
+
+![List](../images/numbered-bookmarks-list-from-all-files.gif)
+
+> Tip: If you simply navigate on the list, the editor will temporarily scroll to its position, giving you a better understanding if that bookmark is what you were looking for.
+

walkthrough/navigateToNumberedBookmarks.nls.pt-br.md

@@ -0,0 +1,12 @@
+## Navegar para Numbered Bookmarks
+
+Bookmarks representam posições no seu código, então você pode voltar a elas de forma rápida e fácil sempre que necessário. 
+
+Essa extensão disponibiliza comandos para nevegar facilmente para cada numbered bookmark, de `Numbered Bookmarks: Pular para Bookmark 0` até `Numbered Bookmarks: Pular para Bookmark 9`, com uma tecla de atalho para cada um (<kbd>Ctrl</kbd> +  <kbd>#number</kbd>)
+
+Mas não está limitado a isso. Também disponibiliza comandos para visualizar todos os Numbered Bookmarks em um arquivo, ou em toda a área de trabalho. Use os comandos `Numbered Bookmarks: Listar` and `Numbered Bookmarks: Listar de Todos os Arquivos`, e a extensão apresentará uma prévia da linha com bookmark e sua posição. 
+
+![Lista](../images/numbered-bookmarks-list-from-all-files.gif)
+
+> Dica: Se você simplesmente navegar pela lista, o editor irá rolar temporariamente para a posição do bookmark, dando-lhe um entendimento melhor se o bookmark é aquele que você está procurando.
+

walkthrough/toggle.md

@@ -0,0 +1,7 @@
+## Toggle Numbered Bookmarks
+
+You can easily Mark/Unmark Numbered Bookmarks on any position. 
+
+![Toggle](../images/numbered-bookmarks-toggle.png)
+
+> Tip: Use Keyboard Shortcut <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>#number</kbd>

walkthrough/toggle.nls.pt-br.md

@@ -0,0 +1,7 @@
+## Anternar Numbered Bookmarks
+
+Você pode adicionar/remover Numbered Bookmarks facilmente em qualquer posição.
+
+![Alternar](../images/numbered-bookmarks-toggle.png)
+
+> Dica: Use o Atalho de Teclado <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>#number</kbd>

walkthrough/workingWithRemotes.md

@@ -0,0 +1,10 @@
+## Working with Remotes
+
+The extension fully supports [Remote Development](https://code.visualstudio.com/docs/remote/remote-overview) scenarios. 
+
+It means that when you connect to a _remote_ location, like a Docker Container, SSH or WSL, the extension will be available, ready to be used. 
+
+> You don't need to install the extension on the remote.
+
+Better yet, if you use `numberedBookmarks.saveBookmarksInProject` setting defined as `true`, the bookmarks saved locally _will be available_ remotely, and you will be able to navigate and update the bookmarks. Just like it was a resource from folder you opened remotely.
+

walkthrough/workingWithRemotes.nls.pt-br.md

@@ -0,0 +1,10 @@
+## Trabalhando com Remotos
+
+A extensão suporta completamente cenários de [Desenvolvimento Remoto](https://code.visualstudio.com/docs/remote/remote-overview). 
+
+Isso significa que quando você conecta a um local _remoto_, como Container Docker, SSH ou WSL, a extensão estará disponível, pronta para ser usada.
+
+> Você não precisa instalar a extensão no ambiente remoto.
+
+Melhor ainda, se você usar a configuração `numberedBookmarks.saveBookmarksInProject` definida como `true`, os bookmarks salvos localmente _estarão disponíveis_ remotamente, e você conseguirá navegar e atualizar os bookmarks. Assim como se fosse um recurso de uma pasta que você abriu remotamente.
+