# Favorite Editor Documentation?

**URL:** <https://discuss.kakoune.com/t/favorite-editor-documentation/381>\
**Category:** Archives\
**Created:** [March 18, 2019, 9:43am UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381 "2019-03-18T09:43:14Z")\
**Posts on this page:** 10\
**Page:** 1

<div class="post-metadata">

**Author:** ![robertmeta](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/robertmeta/32/833_2.png) [@robertmeta](https://discuss.kakoune.com/u/robertmeta)\
**Post date:** [March 18, 2019, 9:43am UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/1 "2019-03-18T09:43:14Z")

</div>

_Poll ([view on site](https://discuss.kakoune.com/t/favorite-editor-documentation/381/1))_

If other – please let me know what.

---

<div class="post-metadata">

**Author:** ![andreyorst](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/andreyorst/32/29_2.png) [@andreyorst](https://discuss.kakoune.com/u/andreyorst)\
**Post date:** [March 18, 2019, 9:56am UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/2 "2019-03-18T09:56:01Z")

</div>

I’m kinda bouncing between Vim and Emacs, as both of those has different ways to handle documentation, but both ways are effective and relatively simple. Still going to vote for Vim, because I’ve used it for longer time than Emacs, but to be fair, I’m not sure which one is better.

---

<div class="post-metadata">

**Author:** ![Screwtapello](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/screwtapello/32/12_2.png) [@Screwtapello](https://discuss.kakoune.com/u/Screwtapello)\
**Post date:** [March 18, 2019, 9:56am UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/3 "2019-03-18T09:56:11Z")

</div>

So, uh, I can’t help but notice Kakoune’s not eligible. 😉

I’m a fan of the breadth and depth of Vim’s documentation, but I can’t honestly say I’ve studied the documentation of any other editor on this list. I assume Emacs’ documentation is in Texinfo format, though, so that’s probably a mark against it…

---

<div class="post-metadata">

**Author:** ![robertmeta](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/robertmeta/32/833_2.png) [@robertmeta](https://discuss.kakoune.com/u/robertmeta)\
**Post date:** [March 18, 2019, 9:58am UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/4 "2019-03-18T09:58:19Z")

</div>

> [@Screwtapello](#):
>
> So, uh, I can’t help but notice Kakoune’s not eligible. 😉

Intentionally – looking for outside models / guides / inspiration / ideas.

---

<div class="post-metadata">

**Author:** ![xyuusha](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/xyuusha/32/48_2.png) [@xyuusha](https://discuss.kakoune.com/u/xyuusha)\
**Post date:** [March 19, 2019, 5:29am UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/5 "2019-03-19T05:29:59Z")

</div>

I think is very hard to top vim regarding documentation. Emacs documentation is not bad at all, but it’s very hard to consume and texinfo format is very bothersome.

What I like/hate about kakoune it that it does not need many documentation (thanks to discoverability and good design) but for the parts that are needed (expansions and other non-basic features) it’s a bit hard to find.

---

<div class="post-metadata">

**Author:** ![alexherbo2](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/alexherbo2/32/1140_2.png) [@alexherbo2](https://discuss.kakoune.com/u/alexherbo2)\
**Post date:** [March 19, 2019, 5:43pm UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/6 "2019-03-19T17:43:51Z")

</div>

@xyuusha I challenge you. Giving the following arguments or selections `One`, `Two and Three`, answer the expansion of:

1. `echo %reg(.)`
2. `echo '%reg(.)'`
3. `echo "%reg(.)"`
4. `echo %~~~%arg(@)~~~`
5. `echo "%arg(@)"`

You have no Kakoune—_No Kakoune?_ 🙀—for trying, no cheating.

Syntax error are accepted answers.

---

<div class="post-metadata">

**Author:** ![xyuusha](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/xyuusha/32/48_2.png) [@xyuusha](https://discuss.kakoune.com/u/xyuusha)\
**Post date:** [March 20, 2019, 2:16pm UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/7 "2019-03-20T14:16:37Z")

</div>

I’m miserably failing this but I’ll try it anyway (and no kakoune? How I’m writing this then).

1. One
2. ‘%reg(.)’
3. One
4. Syntax error
5. One Two and Three

EDIT:  
Yeah, I miserably failed.

---

<div class="post-metadata">

**Author:** ![alexherbo2](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/alexherbo2/32/1140_2.png) [@alexherbo2](https://discuss.kakoune.com/u/alexherbo2)\
**Post date:** [March 20, 2019, 2:39pm UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/8 "2019-03-20T14:39:49Z")

</div>

I have [this picture](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/xyuusha/120/48_1.png) of you trying. xD

Here are the answers:

> **1. echo %reg(.)**
>
> ```auto
> 'One' 'Two and Three'
> 
> ```
> 
> [✗] Returns the selection contents as a list.

> **2. echo '%reg(.)'**
>
> ```auto
> '%reg(.)'
> 
> ```
> 
> [✓] Expansions are not processed inside single quoted strings.

> **3. echo "%reg(.)"**
>
> ```auto
> 'One'
> 
> ```
> 
> [✓] Surprisingly, double quoted strings will not group the elements of the register as a single argument, but expand to the value of the main register, equivalent to `%val(main_reg_dot)`.

> **4. echo %~~~%arg(@)~~~**
>
> ```auto
> '~%arg(@)~'
> 
> ```
> 
> [✗] Returns a literal string delimited by `~` and escaped by doubling the tilde characters. Syntax error was a trap lol.

> **5. echo "%arg(@)"**
>
> ```auto
> 'One Two and Three'
> 
> ```
> 
> [✓] Surprisingly and unlike `%reg(.)`, double quoted strings will group the arg-list as a single argument.

---

<div class="post-metadata">

**Author:** ![robertmeta](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/robertmeta/32/833_2.png) [@robertmeta](https://discuss.kakoune.com/u/robertmeta)\
**Post date:** [March 20, 2019, 9:15pm UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/9 "2019-03-20T21:15:37Z")

</div>

So… I presume 20% isn’t a passing grade… I got the first one right!

---

<div class="post-metadata">

**Author:** ![alexherbo2](https://discuss.kakoune.com/user_avatar/discuss.kakoune.com/alexherbo2/32/1140_2.png) [@alexherbo2](https://discuss.kakoune.com/u/alexherbo2)\
**Post date:** [March 20, 2019, 9:29pm UTC](https://discuss.kakoune.com/t/favorite-editor-documentation/381/10 "2019-03-20T21:29:03Z")

</div>

lol
