More renaming of list to note (in test, docs, etc.)

This commit is contained in:
Paul van Tilburg 2018-03-09 22:23:27 +01:00
parent 79876960bf
commit 225e9c4cde
6 changed files with 18 additions and 18 deletions

4
.gitignore vendored
View File

@ -5,5 +5,5 @@
# Sass stuff # Sass stuff
.sass-cache/ .sass-cache/
# Lists # Notes
lists/*.list notes/*.note

View File

@ -1,6 +1,6 @@
# Version 1.0.1 (3 Jan 2018) # Version 1.0.1 (3 Jan 2018)
Add a More/Less button for uncollapsing/collapsing long lists that Add a More/Less button for uncollapsing/collapsing long notes that
have been cut using a horizontal rule. have been cut using a horizontal rule.
# Version 1.0.0 (2 Jan 2018) # Version 1.0.0 (2 Jan 2018)

View File

@ -3,7 +3,7 @@
A [Rocket](https://rocket.rs) based web application written in Rust for A [Rocket](https://rocket.rs) based web application written in Rust for
maintaining a pinboard of notes for a family or group of friends. maintaining a pinboard of notes for a family or group of friends.
Similarly to a Wiki, all notes can be edited by everyone, as a board with Similarly to a Wiki, all notes can be edited by everyone, as a board with
physical lists would also allow. physical notes would also allow.
## Building ## Building
@ -21,17 +21,17 @@ $ scss static/scss/pinboard.scss:static/csss/pinboard.css
## Usage ## Usage
The lists are stored as plain text files (in Markdown format) under the The notes are stored as plain text files (in Markdown format) under the
`lists` subdirectory. As an administrator of the application, you should `notes` subdirectory. As an administrator of the application, you should
touch a file with the extension `.list` in this subdirectory to create touch a file with the extension `.note` in this subdirectory to create
lists. The resulting list names are the title cased version of the snake notes. The resulting note names are the title cased version of the snake
cased filenames. For example to create a list for "John Doe": cased filenames. For example to create a note for "John Doe":
``` ```
$ touch lists/john_doe.list $ touch notes/john_doe.note
``` ```
After creating new lists, start (or restart) the application and then visit: After creating new notes, start (or restart) the application and then visit:
http://localhost:8000/. http://localhost:8000/.
For setting up production or staging environments, see the For setting up production or staging environments, see the
@ -44,10 +44,10 @@ There are still quite some things left to do. Here are some points of
improvement for the future: improvement for the future:
* Use a Rust-implementation for Sass * Use a Rust-implementation for Sass
* Support different sets of lists (for different environments) * Support different sets of notes (for different environments)
* Get rid of hardcoded strings in the UI (for example the name of my family) * Get rid of hardcoded strings in the UI (for example the name of my family)
* Add i18n to support several languages * Add i18n to support several languages
* Support locking a list while editing it in the client so other clients * Support locking a note while editing it in the client so other clients
cannot edit it cannot edit it
## License ## License

View File

@ -54,7 +54,7 @@ mod tests {
assert_eq!(notes[0].name, "Test"); assert_eq!(notes[0].name, "Test");
assert_eq!( assert_eq!(
notes[0].data, notes[0].data,
"This is a test list\n\n* One\n* Two\n* Three\n" "This is a test note\n\n* One\n* Two\n* Three\n"
); );
// The mtime field can vary, don't test for it // The mtime field can vary, don't test for it
// The path field is private, also don't test for it // The path field is private, also don't test for it
@ -75,7 +75,7 @@ mod tests {
let body = res.body_string().unwrap(); let body = res.body_string().unwrap();
assert_eq!( assert_eq!(
body, body,
r#"<p>This is a test list</p> r#"<p>This is a test note</p>
<ul> <ul>
<li>One</li> <li>One</li>
<li>Two</li> <li>Two</li>
@ -98,7 +98,7 @@ mod tests {
assert_eq!(note.id, "test"); assert_eq!(note.id, "test");
assert_eq!(note.index, 0); assert_eq!(note.index, 0);
assert_eq!(note.name, "Test"); assert_eq!(note.name, "Test");
assert_eq!(note.data, "This is a test list\n\n* One\n* Two\n* Three\n"); assert_eq!(note.data, "This is a test note\n\n* One\n* Two\n* Three\n");
// The mtime field can vary, don't test for it // The mtime field can vary, don't test for it
// The path field is private, also don't test for it // The path field is private, also don't test for it

View File

@ -102,7 +102,7 @@ mod tests {
let note = notes.iter().find(|note| note.id == "test").unwrap(); let note = notes.iter().find(|note| note.id == "test").unwrap();
assert_eq!( assert_eq!(
note.to_html(), note.to_html(),
r#"<p>This is a test list</p> r#"<p>This is a test note</p>
<ul> <ul>
<li>One</li> <li>One</li>
<li>Two</li> <li>Two</li>

View File

@ -1,4 +1,4 @@
This is a test list This is a test note
* One * One
* Two * Two