aboutsummaryrefslogtreecommitdiff
path: root/runtime/tutor/en
Commit message (Collapse)AuthorAge
* refactor(tutor): use inline comments instead of json file #39714Nathan Zeng2026-05-13
| | | | | | | | | | Problem: Expected text for interactive marks is in a separate json file from the tutor file. When the tutor file is updated, line numbers (potentially many) have to be updated in the json file. This is a burden for maintenance and automatic testing. Solution: Put the expected text inline in the tutor file, marked with `[[]]`. Parse and remove the comments before opening the tutor file so extmarks can be applied.
* docs: misc (#37280)zeertzjq2026-01-07
| | | | | | | | | | | | | | | | | | | | Close #36806 Close #36812 Close #37003 Close #37016 Close #37038 Close #37039 Close #37157 Close #37185 Close #37213 Co-authored-by: saroj_r <sarojregmi.official@gmail.com> Co-authored-by: Olivia Kinnear <git@superatomic.dev> Co-authored-by: Igor <igorlfs@ufmg.br> Co-authored-by: Justin Roberts <JustinEdwardLeo@gmail.com> Co-authored-by: "Mike J. McGuirk" <mike.j.mcguirk@gmail.com> Co-authored-by: Aymen Hafeez <49293546+aymenhafeez@users.noreply.github.com> Co-authored-by: Peter Cardenas <16930781+PeterCardenas@users.noreply.github.com> Co-authored-by: DrNayak2306 <dhruvgnk.work@gmail.com>
* vim-patch:757b42a: runtime(tutor): Chapter 2: consistently use upper case ↵zeertzjq2025-12-19
| | | | | | | | | | | | | | letter, fix typo after 1e3e1ba067c79a Chapter 2: Fix missing "R" after 1e3e1ba067c79a when using register from insert mode. While at it, consistently use upper case letter for CTRL-R in the new-tutor. related: vim/vim#18950 https://github.com/vim/vim/commit/757b42ab070632806ab10e94e26b70fc7bb60cb9 Co-authored-by: Christian Brabandt <cb@256bit.org>
* vim-patch:1e3e1ba: runtime(tutor): Update Chapter 2, remove mentioning ↵zeertzjq2025-12-19
| | | | | | | | | | surround plugin fixes: vim/vim#18950 https://github.com/vim/vim/commit/1e3e1ba067c79aa2c7f0d53ed1e102089a29e692 Co-authored-by: Christian Brabandt <cb@256bit.org>
* vim-patch:898ac80: runtime(new-tutor): update vim-02-beginner following ↵zeertzjq2025-11-24
| | | | | | | 48940d9 (#36674) closes: vim/vim#18793 https://github.com/vim/vim/commit/898ac80be6fbeb24a105bd3105061b692db89a1a
* revert: "fix(tutor): remove hyperlinks, simplify non-interactive examples" ↵Justin M. Keyes2025-11-19
| | | | | #36622 This reverts commit 5e039c8e9775651bc24cf8a669d33217b24bd59e.
* fix(tutor): remove hyperlinks, simplify non-interactive examples #36307Eduardo Cruz Guedes2025-10-27
| | | | | | 1. Every hyperlink-like element was replaced by `"$1"` (where $1 is the original string showed in the hyperlink); 2. Arrows `--->` were used in lines containing practice examples when no editing text is involved; 3. Context on interactivity was minimally adapted when strictly needed, not to disrupt the original tutor's intent; 4. Tests regarding the tutor file refactored to ensure the new syntax is not flagged as an error.
* vim-patch:12da242: runtime(new-tutor): fix mismatched line numbers in ↵zeertzjq2025-10-03
| | | | | | | | vim-02-beginner closes: vim/vim#18466 https://github.com/vim/vim/commit/12da2427c7072d97db39d157e7a991b71b278a40
* vim-patch:9d57fe2: runtime(new-tutor): Updated English new tutorzeertzjq2025-10-03
| | | | | | | | | | | | | This updates the new tutor with the changes from commit b87f133b0724f7328e7dd41dd611af67f4ae3e39 closes: vim/vim#18461 https://github.com/vim/vim/commit/9d57fe278f71117414956a33c9beb1407c420ae2 Link to :checkhealth for clipboard support. Co-authored-by: RestorerZ <restorer@mail2k.ru>
* fix(tutor): use legacy syntax for lesson 3.1 #34996Phạm Bình An2025-07-19
| | | | | | | | | | | | | | | | | | | | | Problem: - Extmark breaks lesson 3.1 of vim-01-beginner.tutor because when users delete the line and put it elsewhere, the extmark doesn't move to the put location. - This doesn't mean the extmark implementation is bad though (note that thanks to extmark, for the first time, we can make lesson 2.6 really interactive), it's just that the tutor format has never been made for kinds of lessons like lesson 3.1, which is why all "expected" in that lesson are -1, which also means that lesson is not interactive in the first place. Also see lesson 2.1.3 in vim-02-beginner, where the mark is just used to mark the first line of the exercise, which also prove my point. Solution: - For a not-really-interactive lesson like lesson 3.1, just use legacy syntax. I borrow the old vimtutor's `--->` to mark the exercises of the lesson. - Less redundant interactive marks also make the json files smaller and more maintainable.
* refactor(tutor): reimplement interactive marks as extmark in Luabrianhuster2025-07-18
| | | | | | | | | | | | | | | | | | | Problem: From https://matrix.to/#/!cylwlNXSwagQmZSkzs:matrix.org/$Ofj-TFIsEMbp0O9OhE8xuZSNi-nhRLtZTOgs6JRLNrs?via=matrix.org&via=gitter.im&via=mozilla.org In lesson 2.6, users are asked to remove the second, forth and fifth lines with `dd` command, then they are asked to undo twice to make the text go back to original state. But after that, the mark ✗ appears again, which confuses the user because they think they do something wrong. This is a limitation with the current implementation, which is based on line number only. Solution: Reimplement interactive marks as extmarks in Lua. This also make the feature less fragile, as users can remove, add some arbitrary lines without breaking the interactive marks. Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
* vim-patch:9.1.1404: wrong link to Chapter 2 in new-tutorbrianhuster2025-05-23
| | | | | | | | | | | | | | | Problem: wrong link to Chapter 2 in vim-01-beginner.tutor Solution: Fix the link to Chapter 2, add test for links in tutor files (Phạm Bình An) In order to write the test, I exposed the function `s:GlobTutorials` as `tutor#GlobTutorials` and make it also accept a `locale` argument. closes: vim/vim#17356 https://github.com/vim/vim/commit/e8302da74aee55fe8f6496b5b711fed7d92318c5 Co-authored-by: Phạm Bình An <111893501+brianhuster@users.noreply.github.com>
* vim-patch:2323f22: runtime(new-tutor): add chapter two to the interactive ↵brianhuster2025-05-23
| | | | | | | | | | tutorial closes: vim/vim#16803 https://github.com/vim/vim/commit/2323f225ca8aa61d9a66fd8aac007bec781c048d Co-authored-by: RestorerZ <restorer@mail2k.ru>
* docs(tutor): move lesson 7.2 below lesson 7.3 #33662Phạm Bình An2025-05-21
| | | | | | | | | | | | | | | | Problem: - Lesson 7.3 (Cmdline Completion) teaches an important way to discover Nvim features. I think users should learn it before they start configuring Nvim - Nvim can be configured in Lua as well, but lesson 7.2 (Configuring Nvim) only mentions init.vim. And I think Nvim is promoting Lua more Solution: - Move lesson 7.2 to be after lesson 7.3 - Lesson 7.2 should teach about init.lua Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
* docs: provide example_init.lua #33524Phạm Bình An2025-04-27
| | | | | | | | | Problem: There are some "boilerplate" steps for new users. Although we are constantly improving defaults and lifting patterns into core, users eventually want to know how to start their own config, add plugins, etc. Solution: Add `runtime/example_init.lua` and refer to it from docs.
* vim-patch:829eda7: runtime(new-tutor): update tutor and correct comandline ↵Phạm Bình An2025-04-15
| | | | | | | | | | | | | completion (#33449) Problem: Some parts of the tutor are outdated. - For example, pressing `<Tab>` after typing `:e` does not complete the command `:edit`, but shows a completion menu with the first entry being `:earlier`. closes: vim/vim#17107 https://github.com/vim/vim/commit/829eda7d381e5f635169c927103568b335cd599d
* feat(tutor): give hints to satisfy the line checker #30952echometerain2024-10-27
| | | | | Problem: novice users relying on vimtutor won't know what to do when they follow the instructions and delete a couple lines and that breaks the line checker Solution: tell the user to fix the line numbers after they're done
* fix(tutor): incorrect lines marked as correct #29833Eduardo Rittner Coelho2024-08-16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Problem: In line 308 the poem appears as ✅1) Roses are red, ✅2) Mud is fun, ✅3) Violets are blue, ✅4) I have a car, ✅5) Clocks tell time, ✅6) Sugar is sweet ✅7) And so are you. where the wrong lines (2, 4, 5) are all marked as correct. Solution: Change the tutor.json file so that initially the poem appears as ✅1) Roses are red, ❌2) Mud is fun, ✅3) Violets are blue, ❌4) I have a car, ❌5) Clocks tell time, ❌6) Sugar is sweet ✅7) And so are you. The method for checking whether a line is correct or not is really simple, so I couldn't find a way to display the 6th line as initially correct, however upon deleting lines 2, 4 and 5 the final result shows line 6 as correct.
* docs: misc (#28837)dundargoc2024-06-07
| | | | | | | | | | | | | | | Co-authored-by: Danymat <d.danymat@gmail.com> Co-authored-by: Gregory Anders <greg@gpanders.com> Co-authored-by: Jakub Okoński <jakub@okonski.org> Co-authored-by: John L. Villalovos <john@sodarock.com> Co-authored-by: Maria José Solano <majosolano99@gmail.com> Co-authored-by: Michaili K <git@michaili.dev> Co-authored-by: TheLeoP <eugenio2305@hotmail.com> Co-authored-by: Tobias Schmitz <tobiasschmitz2001@gmail.com> Co-authored-by: W20MC <157727813+W20MC@users.noreply.github.com> Co-authored-by: Will Hopkins <willothyh@gmail.com> Co-authored-by: Yifan Hu <141280278+b0ae989c@users.noreply.github.com> Co-authored-by: glepnir <glephunter@gmail.com> Co-authored-by: prljav <74116121+prljav@users.noreply.github.com>
* docs: fix typos (#27868)dundargoc2024-03-28
| | | | | | | | | Co-authored-by: ite-usagi <77563904+ite-usagi@users.noreply.github.com> Co-authored-by: v-sim <56476039+v-sim@users.noreply.github.com> Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com> Co-authored-by: Quico Augustijn <quico.public@gmail.com> Co-authored-by: nhld <nahnera@gmail.com> Co-authored-by: francisco souza <108725+fsouza@users.noreply.github.com>
* docs: small fixes (#27364)dundargoc2024-03-12
| | | | | | | | Co-authored-by: C.D. MacEachern <craig.daniel.maceachern@gmail.com> Co-authored-by: Ynda Jas <yndajas@gmail.com> Co-authored-by: Owen Hines <TheOdd@users.noreply.github.com> Co-authored-by: Wanten <41904684+WantenMN@users.noreply.github.com> Co-authored-by: lukasvrenner <118417051+lukasvrenner@users.noreply.github.com> Co-authored-by: cuinix <915115094@qq.com>
* docs(tutor): include https urls where applicable (#27461)Marcus Michaels2024-02-16
| | | | Problem: URLs in :Tutor use "http" instead of "https". Solution: Update URLs with a valid "https" equivalent.
* docs: various fixes (#26929)dundargoc2024-01-17
| | | | Co-authored-by: Patrick Bollinger <owner@pjbollinger.com> Co-authored-by: vilo1839 <139687192+vilo1839@users.noreply.github.com>
* fix(tutor): Tutor steps don't work on Windows #25251Leonardo Mello2023-09-26
| | | | | | | | | Problem: Some steps in :Tutor don't work on Windows. Solution: Add support for `{unix:...,win:...}` format and transform the Tutor contents depending on the platform. Fix https://github.com/neovim/neovim/issues/24166
* docs(tutor): clarify the meaning of ✗ and ✓ (#25204)zeertzjq2023-09-17
| | | Also reformat tutor.tutor.json to use 2-space indent while at it.
* fix(tutor): don't use concealed text in expected lines #24316Sean Dewar2023-07-11
|
* docs(tutor): modify for Neovim rather than Vim (#17092)Rory Nesbitt2022-01-30
|
* fix(tutor): formatting, layout #15098Oliver Marriott2021-08-30
| | | | | | | | | | | | | | | | | * fix(tutor): adjust over-80ch lines and corresponding expect file * fix(tutor): standardise indentation and formatting, add nowrap modeline - unifies the formatting/layout, which was a bit inconsistent, - adds a nowrap modeline Since the tutor uses a lot of conceals, which are included in the character count when calculating line wrapping, lines were breaking at what looked like odd spots, which gives a poor first impression and lowered readability. I have adjusted some lines to be over 80ch in the source, but once they're rendered out with conceals, they're actually under 80, so even with nowrap we don't visually extend past 80. fix #15088
* tutor: change arrows (--->) to symbols ✗ and ✓ #11404Nikolay Shebanov2019-11-16
| | | | | * Display ✓ or ✗ based on the line user sees * Add vim-tutor-mode expectations to the lines marked with an arrow. * Fix some existing expectations to behave predictably.
* runtime/tutor [ci skip] #9990juliancoffee2019-05-09
|
* doc: xdg, MAINTAIN.md, channel-id, job controlJustin M. Keyes2018-10-11
| | | | - tutor: emphasize K
* doc: remove mentions of vimrc_exampleJustin M. Keyes2018-05-22
| | | | closes #8426
* tutor: readjust tutor for 80 char wide terminalsFelipe Morales2018-01-01
|
* tutor: some fixes (#7510)Felipe Morales2017-11-08
| | | | - conceal inline types - fix some links
* runtime/tutor: fix typos (#7302)TJ Rana2017-09-23
|
* tutor: disable old method for setting "expect" regionsFelipe Morales2017-07-15
| | | | tutor: remove movement mappings
* tutor: allow metadata to exist outside of the documents.Felipe Morales2017-07-15
| | | | this makes 'expect' regions simpler to handle.
* tutor: some tweaks to begginer's tutorialFelipe Morales2017-07-15
|
* tutor: Update vim-tutor to 0.2.1Felipe Morales2015-11-28
| | | | Also, some tweaks based on input by @fdinoff on gitter.
* tutor: fix typoFelipe Morales2015-10-26
|
* tutor: fix location for init.vim fileFelipe Morales2015-10-26
|
* runtime: Include vim-tutor-modeFelipe Morales2015-08-15
vim-tutor-mode provides a mechanism to write and read interactive tutorials in vim. It's aim is to replace the venerable vimtutor with a more modern system. The plugin's development is maintained at https://github.com/fmoralesc /vim-tutor-mode Closes #2351.
generated by cgit (git 2.34.1) at 2026-10-20 13:03:08 +0000