Introduction
Inclusion Code is an accessible editor that allows you to easily create Markdown documents or HTML content. Once in the editor, you can either write the corresponding codes manually, or use the Insert Menu to generate them automatically.
The Inclusion Code interface is a simple one with menu bars, which uses the standard Windows controls, making it accessible to screen reader programs and braille displays used by blind people.
Starting screen
When Inclusion Code starts, a window will appear with several options that we can select to open the editor. They are:
- HTML
- Markdown
- Exit
If HTML is selected, the editor will open in a blank screen, where you can start inserting the HTML tags codes.
If Markdown is selected, the editor will open in a blank screen, where you can start creating a document using Markdown markup tags.
Selecting Exit will exit the program.
Markdown Editor Mode
This documentation is the help for the Markdown editor option, there is also other help available with the documentation for the HTML editor.
The Markdown editor mode in Inclusion Code makes easier the document creation process by automating Markdown tags. The user selects the desired element from the Insert Menu and the program will generate the corresponding special characters and copy them into the editor. So content can be created in a very short time, without necessarily having to know Markdown.
Also, since the tags can be generated automatically allows the user to learn the different Markdown special characters. Markdown is a markup language that makes it easy to format text using a series of characters in a particular way. Initially, it was designed to produce texts whose destination would be the web more quickly and easily than if we were directly using HTML. But we can also use it for any type of text, regardless of its destination, including the creation of documents.
Recommended use
We recommend using the Markdown editor mode in Inclusion Code to:
- As a Markdown learning tool.
- To quickly create Markdown tagged content and copy and paste it into web publishing tools such as Wordpress, among others.
- Create Markdown documents that integrate headers, lists, links, among others, and export them as a Word document and basic Power Point presentation from the same program.
Markdown editor features
- The program can generate Markdown codes automatically for the element selected from the Insert Menu, copying them into the editor.
- You can preview the Markdown document in the web browser from within the program.
- The program allows you to export Markdown codes from the editor as a Word document (.docx).
- The program allows exporting the Markdown codes from the editor as a simple Power Point presentation (.pptx). There is a Power Point template available from the Insert Menu.
- Reading aloud the Markdown text in the editor as well as the menus selections and program messages. The user can select any of the SAPI5 voices available in Windows.
- Sound effects for various program events.
- Select the font type and size to use in the editor.
- Select high contrast colors for background and editor texts.
- All program options can be used by keyboard commands.
- Menus of the program available in Spanish or English.
Program compatibility
Inclusion Code is compatible with the following Windows versions:
10/8/7 and with both 32 and 64 bit architectures.
Also, Inclusion Code does not require installation, since it is a self-executing program, ideal to have it on a portable USB flash drive, and use it on any Windows computer.
Menus and keyboard commands
List of all program menus, with their keyboard shortcut and a brief description.
File Menu
New
Clear the editor for a new Markdown file.
Alt + f, n
Open
Open a previously saved Markdown file. The same will be loaded in the editor. Important: The Inclusion Code editor supports files with ANSI encoding. To open a document with UTF-8 encoding, it must be done from the Import UTF-8 option.
Alt + f, o
Save
It will save the file that is currently in the editor and that had already been previously saved. It will be saved with the same name. Important: The Inclusion Code editor saves files in ANSI encoding. To save a document with UTF-8 encoding it must be done from the Export UTF-8 option.
Alt + f, s
Save As
Save the current Markdown file, allowing filename selection. Important: The Inclusion Code editor saves files in ANSI encoding. To save a document with UTF-8 encoding it must be done from the Export UTF-8 option.
Alt + f, a
Import UTF-8
A previously saved Markdown file with UTF-8 encoding will open. The same will be loaded in the editor. Important: the Inclusion Code editor will convert the texts as ANSI. To save them again as UTF-8, you must go to the Export UTF-8 option. Alt + f, i
Export UTF-8
Save the current Markdown file in the editor as UTF-8 encoding. Alt + f, e
Print a hard copy of the current Markdown code. Alt + f, p
Exit editor
Exit the editor and return to the main menu.
Alt + f, x
Edit Menu
Undo
Undo the last action.
Alt + e, u
Cut
Remove the current selection and copy it to the clipboard.
Alt + e, c
Copy
Copy the current selection to the clipboard.
Alt + e, o
Paste
Paste the contents of the clipboard at the current caret position.
Alt + e, p
Delete
Delete the selected text.
Alt + e, l
Select All
Select and highlight all text.
Alt + e, s
Find/Replace
Find instance of text and replace it with designated new text.
Alt + e, f
Find Next
Find the next instance of the text designated.
Alt + e, n
Insert menu
Headings
A list will be presented where you can select headings from level 1 to level 6. When you press Enter, a window will appear with an edit box and once the texts have been written, you must press the Enter key for their integration at the current cursor position in the editor.
Alt + i, h
List
First, a window is presented where you must select the type of list, ordered or unordered. Then another window will appear to select the number of items and finally the windows with edit boxes will appear to write the items in the list.
Alt + i, l
Link
A window with an edit box is presented to write the URL of the link (You must write the complete address, including https: //) and press Enter. Then a window will appear with an edit box to write the text of the link and once the texts have been written, the Enter key must be pressed for its integration in the current position of the cursor in the editor.
Alt + i, k
Bold
A window will appear with an edit box and once the texts have been written, the Enter key must be pressed to integrate it with the bold tag at the current cursor position in the editor.
Alt + i, b
Italic
A window will appear with an edit box and once the texts have been written, the Enter key must be pressed to integrate it with the italic tag at the current cursor position in the editor.
Alt + i, i
Blockquote
A window will appear with an edit box and once the texts have been written, the Enter key must be pressed to integrate it with the blockquote tag at the current cursor position in the editor.
Alt + i, q
Horizontal line
The tag corresponding to a horizontal line will be integrated at the current cursor position in the editor.
Alt + i, r
Text
A window will appear with an edit box and once the texts have been written, the Enter key must be pressed to integrate them into the current position of the cursor in the editor. Also, if a block of text is paste it, it will automatically separates each paragraph with a blank line.
Alt + i, t
Power Point template
It will integrate in the editor, text with Markdown codes equivalent to two slides in Power Point. The first slide has a level 1 heading, which is the section. The second slide integrates a level 2 heading with texts and a list.
Alt + i, p
Code menu
Preview in browser
Show the Markdown codes as a web page, on the default Internet browser.
Alt + c, b
Export Word
It will convert the editor's Markdown codes to a Word document. A window will appear where you can write the name of the document in Word format (.docx).
Alt + c, w
Export Power Point
It will convert the editor's Markdown codes to a Power Point presentation. A window will appear where you can write the name of the document in Power Point format (.pptx). Important: From the Insert Menu, you can integrate a template with Markdown codes for a simple Power Point presentation.
Alt + c, p
Document info
A window will appear with the information on the number of lines, characters and words of the texts in the editor.
Alt + c, i
Read editor text
Read the current editor content with the system default text to speech engine.
Alt + c, r
Stop reading
Stop the actual text to speech audio feedback.
Alt + c, s
Settings menu
Language
Select between English or Spanish language for the menus of the program. The software will restart, so the new language can take effect. Also, verify that the actual SAPI5 text to speech voice, is in the same language of the menus. Alt + o, l
Font
Select the desired font face, size and style. All text in the editor will appear in this font.
Alt + o, f
Color contrast
High contrast colors combinations (black background and white letters) can be selected for use in the editor.
Alt + o, c
Sounds
Use sound effects on options windows and code selected from the menus.
Alt + o, s
Text to speech preferences
Choose to activate the speech messages option. Also, change the actual system SAPI5 text to speech voice and language.
Alt + o, t
Help menu
Documentation
This help document will open in your browser.
Alt + h, d
Inclusion Code web page
You will access the www.inclusioncode.com web page, you must have an active Internet connection.
Alt + h, i
About
Information about the current version and author of Inclusion Code.
Alt + h, a