Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Help: format" option in the menu #116

Closed
moshpirit opened this issue Jun 5, 2016 · 11 comments
Closed

"Help: format" option in the menu #116

moshpirit opened this issue Jun 5, 2016 · 11 comments
Labels
enhancement UX user experience

Comments

@moshpirit
Copy link

You could also add it to the About menu, for newbies that's a nice way to learn how to use it and why is he viewing his notes this way.

@stefan-niedermann stefan-niedermann added enhancement UX user experience labels Jun 6, 2016
@stefan-niedermann stefan-niedermann added this to the 0.10.0 milestone Aug 31, 2016
@stefan-niedermann stefan-niedermann removed this from the 0.10.0 milestone Dec 20, 2016
@dan0xii

This comment has been minimized.

@stefan-niedermann

This comment has been minimized.

@moshpirit

This comment has been minimized.

@stefan-niedermann

This comment has been minimized.

@korelstar

This comment has been minimized.

@stefan-niedermann
Copy link
Member

Okay, then the remaining question is where to put the help for formatting notes with markdown:

  • The grafik menu in edit view
  • in the sidebar above the "settings" entry
  • as a new tab in the "about" view

@jancborchardt
Copy link
Member

in the sidebar above the "settings" entry

I’d say this makes most sense. That way it’s reasonably accessible but not always in your face, especially for people who already know Markdown or don’t even use it. :)
We can simply call the entry "Formatting" and the content can be very similar to https://guides.github.com/features/mastering-markdown/ (the simplest and best Markdown guide for newcomers I found so far).

stefan-niedermann added a commit that referenced this issue Jun 7, 2020
Make checkboxes togglable
stefan-niedermann added a commit that referenced this issue Jun 7, 2020
Make checkboxes togglable
@stefan-niedermann
Copy link
Member

Current progress: Merged into master, but disabled with a feature toggle.

We have to clarify how to translate this stuff first. Then i will enable this feature.

@stefan-niedermann
Copy link
Member

Will be fixed in 2.14.0. Sneak preview:

a

Current content:


Context based formatting

A major design goal of the Notes app is to provide a distraction free tool. Though you will be able to format your texts with Markdown. For various of the below mentioned examples, you can use shortcuts so you can format your notes without typing in the codes below.
Just select a range of text or tap on your cursor at any position and you will get a popup menu which contains next to the default entries Cut, Copy, Select all entries like Link or Checkbox.


Text

It's very easy to make some words bold and other words italic with Markdown. You can strike some words through and even link to Google.

It's very easy to make some words **bold** and other words *italic* with Markdown. You can ~~strike~~ some words through and even [link to Google](http://google.com).

Lists

Sometimes you want numbered lists:

  1. One
  2. Two
  3. Three

Sometimes you want bullet points:

  • Start a line with a star
  • Profit!

Alternatively,

  • Dashes work just as well
  • And if you have sub points, put two spaces before the dash or star:
    • Like this
    • And this
Sometimes you want numbered lists:

1. One
2. Two
3. Three

Sometimes you want bullet points:

* Start a line with a star
* Profit!

Alternatively,

- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
  - Like this
  - And this

Checkbox

To create a checkbox, use a list followed by brackets

  • Item 1
  • Item 2
To create a checkbox, use a list followed by brackets

- [ ] Item 1
* [ ] Item 2

Structured documents

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.

This is a third-tier heading

You can use one # all the way up to ###### six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

Coffee. The finest organic suspension ever devised... I beat the Borg with it.

  • Captain Janeway
# Structured documents

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.

### This is a third-tier heading

You can use one `#` all the way up to `######` six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
> - Captain Janeway

Code

There are many different ways to style code with Markdown. If you have inline code blocks, wrap them in backticks:

`var example = true`
var example = true

Markdown also supports something called code fencing, which allows for multiple lines without indentation:

```
if (isAwesome){
return true
}
```

if (isAwesome){
  return true
}

And if you'd like to use syntax highlighting, include the language:

```javascript
if (isAwesome){
return true
}
```

if (isAwesome){
  return true
}

Unsupported

While we try to continuously improve the support for Markdown, there are a few features which are not yet supported by Notes:

  • Tables
  • Images

If you are interested in contributing support for one of those features, get in contact with us via GitHub or E-Mail.

@jancborchardt
Copy link
Member

Good stuff! :) I'd only change 2 things:

  • For simplicity, only mention the dashes for lists. Stars are for bolding, makes it easier to remember and dashes for lists also look better in plain text.
  • The link to Google could instead be nextcloud.com? ;)

@stefan-niedermann
Copy link
Member

The link to Google could instead be nextcloud.com?

It does 😆 I thought the exact same, and the app does point to nextcloud.com^^

For simplicity, only mention the dashes for lists. Stars are for bolding, makes it easier to remember and dashes for lists also look better in plain text.

I will adjust that in one of the next releases. I orientated at your link (GitHub flavored Markdown).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement UX user experience
Projects
None yet
Development

No branches or pull requests

5 participants