Documentation

[rdytogokev]

One of my favorite features of Sublime Text is the ability to have multiple editing cursors. If you have not seen it before, Sublime's website has an animation of it on their homepage. https://www.sublimetext.com/ It's a major selling point.

Recently, I found out that the ACE editor is already capable of doing the same thing. Here is the default keybindings documentation. https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Soon as I learned the keyboard bindings I started using it right away.

That is when it hit me, AceIDE could use some basic documentation. I propose two things:

1. Develop the Ace IDE Wiki pages https://github.com/AceIDE/editor/wiki. The first page I would add is the keybindings. I would be willing to contribute some basic content to the wiki if needed.

2. Create a simple icon in the app interface to direct people to the wiki for help.

What do you think?

[shanept]

I like the idea of having it built into the app. However I'll be moving settings to its own page so putting documentation on its own page wouldn't be a bad idea

[rdytogokev]

Gravity Forms has a built-in help page like you are suggesting. I think it looks pretty nice.

The way it works with Gravity Forms is: When a link is clicked, it opens a page on the Gravity Forms website that has the content.

Is this how you would like it to work?

[shanept]

Hmm We could point it to wiki pages here on github. That would work.

But for things like shortcuts, that could be built into the plugin itself, I think.

[rdytogokev]

Sounds good. Do you need help with making the documentation admin page?

[shanept]

It would be great if you could help come up with some content!!

On 31 Mar 2017, 11:58 PM, at 11:58 PM, Kevin Young notifications@github.com wrote:

Sounds good. Do you need help with making the documentation admin page?

-- You are receiving this because you commented. Reply to this email directly or view it on GitHub: https://github.com/AceIDE/editor/issues/13#issuecomment-290752791

[shanept]

So as far as I can currently see, topics for documentation are as follows:

General Ace editor shortcuts AceIDE programming/filter advice

Can you think of any more subjects?

[rdytogokev]

Four main area's need to be addressed:

• AceIDE Basics: Opening, Modifying and Saving Files, Opening Directories.
• AceIDE Shortcuts: Text Selection, Editing and Deleting Text, Find and Replace, Code Folding.
• AceIDE Settings: Theme, Adjusting Tabs, Gutters, Scrollbars, Font Size, Guidelines, Invisible Characters.
• AceIDE Development: Contributing, Coding Standards, Programming/Filter advice, Submitting Bug Reports and Feature Requests.

What do you think?

[shanept]

I like that. Very nicely structured. I'll start to create the wikis

[rdytogokev]

Have you created those wikis?

[shanept]

Not as of yet. I've been very busy past few months and haven't even given it any thought, unfortunately.