From 1f07c1f457c79c961b0114274b7f236b7fa9adbb Mon Sep 17 00:00:00 2001 From: rebekahlow-jy Date: Tue, 9 May 2017 12:16:22 +0800 Subject: [PATCH 1/6] Standardise .md files to lowercase file name --- book/common/{Definitions.md => definitions.md} | 0 book/common/{PopOvers.md => popOvers.md} | 0 book/common/{References.md => references.md} | 0 book/index.md | 4 ++-- book/introduction/index.md | 6 +++--- .../questions/{L1P1-E1.md => l1p1-e1.md} | 0 .../questions/{L1P1-Q1.md => l1p1-q1.md} | 0 .../questions/{L1P1-Q2.md => l1p1-q2.md} | 0 book/requirements/{Preview.md => preview.md} | 0 book/requirements/quality/index.md | 2 +- book/requirements/specifying/index.md | 2 +- book/requirements/{TopicToc.md => topicToc.md} | 2 +- book/requirements/userStories/Preview.md | 3 --- .../userStories/details/Exercises.md | 4 ---- .../userStories/details/exercises.md | 4 ++++ book/requirements/userStories/details/index.md | 4 ++-- .../details/{Outcomes.md => outcomes.md} | 0 ...Essay-WriteEpic.md => q-essay-writeEpic.md} | 0 .../details/{Resources.md => resources.md} | 0 .../details/{TopicPanel.md => topicPanel.md} | 2 +- book/requirements/userStories/index.md | 6 +++--- .../userStories/introduction/Exercises.md | 11 ----------- .../userStories/introduction/exercises.md | 11 +++++++++++ .../introduction/{Humor.md => humor.md} | 0 .../userStories/introduction/index.md | 12 ++++++------ .../introduction/{Outcomes.md => outcomes.md} | 0 ...erStory.md => q-essay-critiqueUserStory.md} | 2 +- ...UserStories.md => q-essay-hrUserStories.md} | 2 +- ...-tick-correctStatementsAboutUserStories.md} | 0 .../{Resources.md => resources.md} | 0 .../{TopicPanel.md => topicPanel.md} | 2 +- ...UserStoriesInUse.md => userStoriesInUse.md} | 0 book/requirements/userStories/preview.md | 3 +++ .../{TopicPanel.md => topicPanel.md} | 0 .../userStories/{TopicToc.md => topicToc.md} | 2 +- .../userStories/usage/Exercises.md | 4 ---- .../userStories/usage/exercises.md | 4 ++++ book/requirements/userStories/usage/index.md | 6 +++--- .../usage/{Outcomes.md => outcomes.md} | 0 .../usage/{Resources.md => resources.md} | 0 .../usage/{TopicPanel.md => topicPanel.md} | 2 +- book/se-pattern/introduction/Questions.md | 7 ------- .../introduction/{Apply.md => apply.md} | 2 +- .../se-pattern/introduction/{GoF.md => gof.md} | 0 .../introduction/{Humor.md => humor.md} | 0 book/se-pattern/introduction/index.md | 18 +++++++++--------- .../introduction/{Outcomes.md => outcomes.md} | 4 ++-- ...IsAPattern.md => q-essay-whatIsAPattern.md} | 2 +- ...tributes.md => q-tick-patternAttributes.md} | 0 book/se-pattern/introduction/questions.md | 7 +++++++ .../{Resources.md => resources.md} | 0 .../singleton/{Apply.md => apply.md} | 2 +- .../singleton/{Humor.md => humor.md} | 0 book/se-pattern/singleton/index.md | 10 +++++----- .../singleton/{Outcomes.md => outcomes.md} | 0 .../singleton/{Resources.md => resources.md} | 0 contents/textbook/{L1P1.md => l1p1.md} | 6 +++--- .../questions/{L1P1-E1.md => l1p1-e1.md} | 0 .../questions/{L1P1-Q1.md => l1p1-q1.md} | 0 .../questions/{L1P1-Q2.md => l1p1-q2.md} | 0 site.json | 4 ++-- 61 files changed, 81 insertions(+), 81 deletions(-) rename book/common/{Definitions.md => definitions.md} (100%) rename book/common/{PopOvers.md => popOvers.md} (100%) rename book/common/{References.md => references.md} (100%) rename book/introduction/questions/{L1P1-E1.md => l1p1-e1.md} (100%) rename book/introduction/questions/{L1P1-Q1.md => l1p1-q1.md} (100%) rename book/introduction/questions/{L1P1-Q2.md => l1p1-q2.md} (100%) rename book/requirements/{Preview.md => preview.md} (100%) rename book/requirements/{TopicToc.md => topicToc.md} (88%) delete mode 100644 book/requirements/userStories/Preview.md delete mode 100644 book/requirements/userStories/details/Exercises.md create mode 100644 book/requirements/userStories/details/exercises.md rename book/requirements/userStories/details/{Outcomes.md => outcomes.md} (100%) rename book/requirements/userStories/details/{Q-Essay-WriteEpic.md => q-essay-writeEpic.md} (100%) rename book/requirements/userStories/details/{Resources.md => resources.md} (100%) rename book/requirements/userStories/details/{TopicPanel.md => topicPanel.md} (83%) delete mode 100644 book/requirements/userStories/introduction/Exercises.md create mode 100644 book/requirements/userStories/introduction/exercises.md rename book/requirements/userStories/introduction/{Humor.md => humor.md} (100%) rename book/requirements/userStories/introduction/{Outcomes.md => outcomes.md} (100%) rename book/requirements/userStories/introduction/{Q-Essay-CritiqueUserStory.md => q-essay-critiqueUserStory.md} (88%) rename book/requirements/userStories/introduction/{Q-Essay-HrUserStories.md => q-essay-hrUserStories.md} (91%) rename book/requirements/userStories/introduction/{Q-Tick-CorrectStatementsAboutUserStories.md => q-tick-correctStatementsAboutUserStories.md} (100%) rename book/requirements/userStories/introduction/{Resources.md => resources.md} (100%) rename book/requirements/userStories/introduction/{TopicPanel.md => topicPanel.md} (82%) rename book/requirements/userStories/introduction/{UserStoriesInUse.md => userStoriesInUse.md} (100%) create mode 100644 book/requirements/userStories/preview.md rename book/requirements/userStories/{TopicPanel.md => topicPanel.md} (100%) rename book/requirements/userStories/{TopicToc.md => topicToc.md} (87%) delete mode 100644 book/requirements/userStories/usage/Exercises.md create mode 100644 book/requirements/userStories/usage/exercises.md rename book/requirements/userStories/usage/{Outcomes.md => outcomes.md} (100%) rename book/requirements/userStories/usage/{Resources.md => resources.md} (100%) rename book/requirements/userStories/usage/{TopicPanel.md => topicPanel.md} (84%) delete mode 100644 book/se-pattern/introduction/Questions.md rename book/se-pattern/introduction/{Apply.md => apply.md} (69%) rename book/se-pattern/introduction/{GoF.md => gof.md} (100%) rename book/se-pattern/introduction/{Humor.md => humor.md} (100%) rename book/se-pattern/introduction/{Outcomes.md => outcomes.md} (74%) rename book/se-pattern/introduction/{Q-Essay-WhatIsAPattern.md => q-essay-whatIsAPattern.md} (73%) rename book/se-pattern/introduction/{Q-Tick-PatternAttributes.md => q-tick-patternAttributes.md} (100%) create mode 100644 book/se-pattern/introduction/questions.md rename book/se-pattern/introduction/{Resources.md => resources.md} (100%) rename book/se-pattern/singleton/{Apply.md => apply.md} (69%) rename book/se-pattern/singleton/{Humor.md => humor.md} (100%) rename book/se-pattern/singleton/{Outcomes.md => outcomes.md} (100%) rename book/se-pattern/singleton/{Resources.md => resources.md} (100%) rename contents/textbook/{L1P1.md => l1p1.md} (97%) rename contents/textbook/questions/{L1P1-E1.md => l1p1-e1.md} (100%) rename contents/textbook/questions/{L1P1-Q1.md => l1p1-q1.md} (100%) rename contents/textbook/questions/{L1P1-Q2.md => l1p1-q2.md} (100%) diff --git a/book/common/Definitions.md b/book/common/definitions.md similarity index 100% rename from book/common/Definitions.md rename to book/common/definitions.md diff --git a/book/common/PopOvers.md b/book/common/popOvers.md similarity index 100% rename from book/common/PopOvers.md rename to book/common/popOvers.md diff --git a/book/common/References.md b/book/common/references.md similarity index 100% rename from book/common/References.md rename to book/common/references.md diff --git a/book/index.md b/book/index.md index eb33234..53a6096 100644 --- a/book/index.md +++ b/book/index.md @@ -8,9 +8,9 @@ ### Requirements - + - + * [Product design]() diff --git a/book/introduction/index.md b/book/introduction/index.md index c589480..fe07315 100644 --- a/book/introduction/index.md +++ b/book/introduction/index.md @@ -78,13 +78,13 @@ This then is programming, both a tar pit in which many efforts have floundered a - + ## Practice question - - + + diff --git a/book/introduction/questions/L1P1-E1.md b/book/introduction/questions/l1p1-e1.md similarity index 100% rename from book/introduction/questions/L1P1-E1.md rename to book/introduction/questions/l1p1-e1.md diff --git a/book/introduction/questions/L1P1-Q1.md b/book/introduction/questions/l1p1-q1.md similarity index 100% rename from book/introduction/questions/L1P1-Q1.md rename to book/introduction/questions/l1p1-q1.md diff --git a/book/introduction/questions/L1P1-Q2.md b/book/introduction/questions/l1p1-q2.md similarity index 100% rename from book/introduction/questions/L1P1-Q2.md rename to book/introduction/questions/l1p1-q2.md diff --git a/book/requirements/Preview.md b/book/requirements/preview.md similarity index 100% rename from book/requirements/Preview.md rename to book/requirements/preview.md diff --git a/book/requirements/quality/index.md b/book/requirements/quality/index.md index 863163c..09a9dc1 100644 --- a/book/requirements/quality/index.md +++ b/book/requirements/quality/index.md @@ -23,7 +23,7 @@ Besides these criteria for individual requirements, the set of requirements as a
- +
diff --git a/book/requirements/specifying/index.md b/book/requirements/specifying/index.md index 9d1d510..6b69efa 100644 --- a/book/requirements/specifying/index.md +++ b/book/requirements/specifying/index.md @@ -16,7 +16,7 @@ - + ----------------------------------------- diff --git a/book/requirements/TopicToc.md b/book/requirements/topicToc.md similarity index 88% rename from book/requirements/TopicToc.md rename to book/requirements/topicToc.md index 29deba6..79e5b74 100644 --- a/book/requirements/TopicToc.md +++ b/book/requirements/topicToc.md @@ -3,6 +3,6 @@
- +
diff --git a/book/requirements/userStories/Preview.md b/book/requirements/userStories/Preview.md deleted file mode 100644 index 8e05de1..0000000 --- a/book/requirements/userStories/Preview.md +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/book/requirements/userStories/details/Exercises.md b/book/requirements/userStories/details/Exercises.md deleted file mode 100644 index f8a93f4..0000000 --- a/book/requirements/userStories/details/Exercises.md +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/book/requirements/userStories/details/exercises.md b/book/requirements/userStories/details/exercises.md new file mode 100644 index 0000000..6a5d84a --- /dev/null +++ b/book/requirements/userStories/details/exercises.md @@ -0,0 +1,4 @@ + + + + diff --git a/book/requirements/userStories/details/index.md b/book/requirements/userStories/details/index.md index 484ef98..4c57d65 100644 --- a/book/requirements/userStories/details/index.md +++ b/book/requirements/userStories/details/index.md @@ -88,11 +88,11 @@ User stories for a travel website (credit: Mike Cohen) - + - + diff --git a/book/requirements/userStories/details/Outcomes.md b/book/requirements/userStories/details/outcomes.md similarity index 100% rename from book/requirements/userStories/details/Outcomes.md rename to book/requirements/userStories/details/outcomes.md diff --git a/book/requirements/userStories/details/Q-Essay-WriteEpic.md b/book/requirements/userStories/details/q-essay-writeEpic.md similarity index 100% rename from book/requirements/userStories/details/Q-Essay-WriteEpic.md rename to book/requirements/userStories/details/q-essay-writeEpic.md diff --git a/book/requirements/userStories/details/Resources.md b/book/requirements/userStories/details/resources.md similarity index 100% rename from book/requirements/userStories/details/Resources.md rename to book/requirements/userStories/details/resources.md diff --git a/book/requirements/userStories/details/TopicPanel.md b/book/requirements/userStories/details/topicPanel.md similarity index 83% rename from book/requirements/userStories/details/TopicPanel.md rename to book/requirements/userStories/details/topicPanel.md index d0512cb..e2b7ff0 100644 --- a/book/requirements/userStories/details/TopicPanel.md +++ b/book/requirements/userStories/details/topicPanel.md @@ -1,7 +1,7 @@ #### More detailed user stories :two: - + diff --git a/book/requirements/userStories/index.md b/book/requirements/userStories/index.md index d071266..e87c9a3 100644 --- a/book/requirements/userStories/index.md +++ b/book/requirements/userStories/index.md @@ -6,9 +6,9 @@
- - - + + +
diff --git a/book/requirements/userStories/introduction/Exercises.md b/book/requirements/userStories/introduction/Exercises.md deleted file mode 100644 index 7115693..0000000 --- a/book/requirements/userStories/introduction/Exercises.md +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - diff --git a/book/requirements/userStories/introduction/exercises.md b/book/requirements/userStories/introduction/exercises.md new file mode 100644 index 0000000..b60d920 --- /dev/null +++ b/book/requirements/userStories/introduction/exercises.md @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/book/requirements/userStories/introduction/Humor.md b/book/requirements/userStories/introduction/humor.md similarity index 100% rename from book/requirements/userStories/introduction/Humor.md rename to book/requirements/userStories/introduction/humor.md diff --git a/book/requirements/userStories/introduction/index.md b/book/requirements/userStories/introduction/index.md index 7325f83..3c961c1 100644 --- a/book/requirements/userStories/introduction/index.md +++ b/book/requirements/userStories/introduction/index.md @@ -7,13 +7,13 @@
- + **A common format** for writing user stories is: - + @@ -29,22 +29,22 @@ Examples (from a Learning Management System): **We can write user stories on** index cards or sticky notes, and arrange on walls or tables, to facilitate planning and discussion. Alternatively, we can use a software such as [GitHub Project Boards](https://help.github.com/articles/about-project-boards/) to manage user stories digitally. - + - + - + - + diff --git a/book/requirements/userStories/introduction/Outcomes.md b/book/requirements/userStories/introduction/outcomes.md similarity index 100% rename from book/requirements/userStories/introduction/Outcomes.md rename to book/requirements/userStories/introduction/outcomes.md diff --git a/book/requirements/userStories/introduction/Q-Essay-CritiqueUserStory.md b/book/requirements/userStories/introduction/q-essay-critiqueUserStory.md similarity index 88% rename from book/requirements/userStories/introduction/Q-Essay-CritiqueUserStory.md rename to book/requirements/userStories/introduction/q-essay-critiqueUserStory.md index f18ac7f..5a7136a 100644 --- a/book/requirements/userStories/introduction/Q-Essay-CritiqueUserStory.md +++ b/book/requirements/userStories/introduction/q-essay-critiqueUserStory.md @@ -8,7 +8,7 @@ Critique the following user story taken from a software project to build an e-co
Refer to the definition of a user story. - +
diff --git a/book/requirements/userStories/introduction/Q-Essay-HrUserStories.md b/book/requirements/userStories/introduction/q-essay-hrUserStories.md similarity index 91% rename from book/requirements/userStories/introduction/Q-Essay-HrUserStories.md rename to book/requirements/userStories/introduction/q-essay-hrUserStories.md index 026b30c..50c2931 100644 --- a/book/requirements/userStories/introduction/Q-Essay-HrUserStories.md +++ b/book/requirements/userStories/introduction/q-essay-hrUserStories.md @@ -6,7 +6,7 @@ Bill wants you to build a Human Resource Management (HRM) system. He mentions th
Remember to follow the correct format when writing user stories. - +
diff --git a/book/requirements/userStories/introduction/Q-Tick-CorrectStatementsAboutUserStories.md b/book/requirements/userStories/introduction/q-tick-correctStatementsAboutUserStories.md similarity index 100% rename from book/requirements/userStories/introduction/Q-Tick-CorrectStatementsAboutUserStories.md rename to book/requirements/userStories/introduction/q-tick-correctStatementsAboutUserStories.md diff --git a/book/requirements/userStories/introduction/Resources.md b/book/requirements/userStories/introduction/resources.md similarity index 100% rename from book/requirements/userStories/introduction/Resources.md rename to book/requirements/userStories/introduction/resources.md diff --git a/book/requirements/userStories/introduction/TopicPanel.md b/book/requirements/userStories/introduction/topicPanel.md similarity index 82% rename from book/requirements/userStories/introduction/TopicPanel.md rename to book/requirements/userStories/introduction/topicPanel.md index b8dfb5c..a20c813 100644 --- a/book/requirements/userStories/introduction/TopicPanel.md +++ b/book/requirements/userStories/introduction/topicPanel.md @@ -2,7 +2,7 @@ #### Introduction :one: - + diff --git a/book/requirements/userStories/introduction/UserStoriesInUse.md b/book/requirements/userStories/introduction/userStoriesInUse.md similarity index 100% rename from book/requirements/userStories/introduction/UserStoriesInUse.md rename to book/requirements/userStories/introduction/userStoriesInUse.md diff --git a/book/requirements/userStories/preview.md b/book/requirements/userStories/preview.md new file mode 100644 index 0000000..21f7627 --- /dev/null +++ b/book/requirements/userStories/preview.md @@ -0,0 +1,3 @@ + + + diff --git a/book/requirements/userStories/TopicPanel.md b/book/requirements/userStories/topicPanel.md similarity index 100% rename from book/requirements/userStories/TopicPanel.md rename to book/requirements/userStories/topicPanel.md diff --git a/book/requirements/userStories/TopicToc.md b/book/requirements/userStories/topicToc.md similarity index 87% rename from book/requirements/userStories/TopicToc.md rename to book/requirements/userStories/topicToc.md index 24d6242..4bbb28e 100644 --- a/book/requirements/userStories/TopicToc.md +++ b/book/requirements/userStories/topicToc.md @@ -3,7 +3,7 @@
- +
diff --git a/book/requirements/userStories/usage/Exercises.md b/book/requirements/userStories/usage/Exercises.md deleted file mode 100644 index 1e98eca..0000000 --- a/book/requirements/userStories/usage/Exercises.md +++ /dev/null @@ -1,4 +0,0 @@ - - - ... - diff --git a/book/requirements/userStories/usage/exercises.md b/book/requirements/userStories/usage/exercises.md new file mode 100644 index 0000000..563eb64 --- /dev/null +++ b/book/requirements/userStories/usage/exercises.md @@ -0,0 +1,4 @@ + + + ... + diff --git a/book/requirements/userStories/usage/index.md b/book/requirements/userStories/usage/index.md index 84e35c2..2d8de37 100644 --- a/book/requirements/userStories/usage/index.md +++ b/book/requirements/userStories/usage/index.md @@ -34,11 +34,11 @@ impatient user | to be able experience reasonable response time from the website - + - + @@ -47,7 +47,7 @@ impatient user | to be able experience reasonable response time from the website - uses User stories to capture requirements. + uses User stories to capture requirements. [This page](http://www.extremeprogramming.org/rules/userstories.html) in their website explains the difference between user stories and traditional requirements. diff --git a/book/requirements/userStories/usage/Outcomes.md b/book/requirements/userStories/usage/outcomes.md similarity index 100% rename from book/requirements/userStories/usage/Outcomes.md rename to book/requirements/userStories/usage/outcomes.md diff --git a/book/requirements/userStories/usage/Resources.md b/book/requirements/userStories/usage/resources.md similarity index 100% rename from book/requirements/userStories/usage/Resources.md rename to book/requirements/userStories/usage/resources.md diff --git a/book/requirements/userStories/usage/TopicPanel.md b/book/requirements/userStories/usage/topicPanel.md similarity index 84% rename from book/requirements/userStories/usage/TopicPanel.md rename to book/requirements/userStories/usage/topicPanel.md index 6208fe6..6cfc1bd 100644 --- a/book/requirements/userStories/usage/TopicPanel.md +++ b/book/requirements/userStories/usage/topicPanel.md @@ -1,7 +1,7 @@ #### Putting user stories to good use :three: - + diff --git a/book/se-pattern/introduction/Questions.md b/book/se-pattern/introduction/Questions.md deleted file mode 100644 index 10c1802..0000000 --- a/book/se-pattern/introduction/Questions.md +++ /dev/null @@ -1,7 +0,0 @@ -:question: Definition of a _design pattern_ - - -
-:question: Attributes of a _design pattern_ - - diff --git a/book/se-pattern/introduction/Apply.md b/book/se-pattern/introduction/apply.md similarity index 69% rename from book/se-pattern/introduction/Apply.md rename to book/se-pattern/introduction/apply.md index e955b65..32463c5 100644 --- a/book/se-pattern/introduction/Apply.md +++ b/book/se-pattern/introduction/apply.md @@ -1 +1 @@ -* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/LearningOutcomes.md#apply-design-patterns-lo-designpatterns) +* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/Learningoutcomes.md#apply-design-patterns-lo-designpatterns) diff --git a/book/se-pattern/introduction/GoF.md b/book/se-pattern/introduction/gof.md similarity index 100% rename from book/se-pattern/introduction/GoF.md rename to book/se-pattern/introduction/gof.md diff --git a/book/se-pattern/introduction/Humor.md b/book/se-pattern/introduction/humor.md similarity index 100% rename from book/se-pattern/introduction/Humor.md rename to book/se-pattern/introduction/humor.md diff --git a/book/se-pattern/introduction/index.md b/book/se-pattern/introduction/index.md index 706c908..f0a4214 100644 --- a/book/se-pattern/introduction/index.md +++ b/book/se-pattern/introduction/index.md @@ -18,7 +18,7 @@
- + @@ -30,23 +30,23 @@ - + - + - + - + - + @@ -56,16 +56,16 @@
- +
- +
- + diff --git a/book/se-pattern/introduction/Outcomes.md b/book/se-pattern/introduction/outcomes.md similarity index 74% rename from book/se-pattern/introduction/Outcomes.md rename to book/se-pattern/introduction/outcomes.md index 3ae2c0c..5f73def 100644 --- a/book/se-pattern/introduction/Outcomes.md +++ b/book/se-pattern/introduction/outcomes.md @@ -1,7 +1,7 @@ - + - + diff --git a/book/se-pattern/introduction/Q-Essay-WhatIsAPattern.md b/book/se-pattern/introduction/q-essay-whatIsAPattern.md similarity index 73% rename from book/se-pattern/introduction/Q-Essay-WhatIsAPattern.md rename to book/se-pattern/introduction/q-essay-whatIsAPattern.md index a64b586..5610f2b 100644 --- a/book/se-pattern/introduction/Q-Essay-WhatIsAPattern.md +++ b/book/se-pattern/introduction/q-essay-whatIsAPattern.md @@ -9,7 +9,7 @@ Keywords: reusable, elegant, recurring, context
- +
\ No newline at end of file diff --git a/book/se-pattern/introduction/Q-Tick-PatternAttributes.md b/book/se-pattern/introduction/q-tick-patternAttributes.md similarity index 100% rename from book/se-pattern/introduction/Q-Tick-PatternAttributes.md rename to book/se-pattern/introduction/q-tick-patternAttributes.md diff --git a/book/se-pattern/introduction/questions.md b/book/se-pattern/introduction/questions.md new file mode 100644 index 0000000..6ab9960 --- /dev/null +++ b/book/se-pattern/introduction/questions.md @@ -0,0 +1,7 @@ +:question: Definition of a _design pattern_ + + +
+:question: Attributes of a _design pattern_ + + diff --git a/book/se-pattern/introduction/Resources.md b/book/se-pattern/introduction/resources.md similarity index 100% rename from book/se-pattern/introduction/Resources.md rename to book/se-pattern/introduction/resources.md diff --git a/book/se-pattern/singleton/Apply.md b/book/se-pattern/singleton/apply.md similarity index 69% rename from book/se-pattern/singleton/Apply.md rename to book/se-pattern/singleton/apply.md index e955b65..32463c5 100644 --- a/book/se-pattern/singleton/Apply.md +++ b/book/se-pattern/singleton/apply.md @@ -1 +1 @@ -* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/LearningOutcomes.md#apply-design-patterns-lo-designpatterns) +* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/Learningoutcomes.md#apply-design-patterns-lo-designpatterns) diff --git a/book/se-pattern/singleton/Humor.md b/book/se-pattern/singleton/humor.md similarity index 100% rename from book/se-pattern/singleton/Humor.md rename to book/se-pattern/singleton/humor.md diff --git a/book/se-pattern/singleton/index.md b/book/se-pattern/singleton/index.md index c59ade4..93ba6f3 100644 --- a/book/se-pattern/singleton/index.md +++ b/book/se-pattern/singleton/index.md @@ -100,19 +100,19 @@ class GlobalClass - + - + - + - + @@ -121,7 +121,7 @@ class GlobalClass
- +
diff --git a/book/se-pattern/singleton/Outcomes.md b/book/se-pattern/singleton/outcomes.md similarity index 100% rename from book/se-pattern/singleton/Outcomes.md rename to book/se-pattern/singleton/outcomes.md diff --git a/book/se-pattern/singleton/Resources.md b/book/se-pattern/singleton/resources.md similarity index 100% rename from book/se-pattern/singleton/Resources.md rename to book/se-pattern/singleton/resources.md diff --git a/contents/textbook/L1P1.md b/contents/textbook/l1p1.md similarity index 97% rename from contents/textbook/L1P1.md rename to contents/textbook/l1p1.md index fd6063a..b466a6c 100644 --- a/contents/textbook/L1P1.md +++ b/contents/textbook/l1p1.md @@ -65,11 +65,11 @@ This then is programming, both a tar pit in which many efforts have floundered a - + ## Practice question - - + + diff --git a/contents/textbook/questions/L1P1-E1.md b/contents/textbook/questions/l1p1-e1.md similarity index 100% rename from contents/textbook/questions/L1P1-E1.md rename to contents/textbook/questions/l1p1-e1.md diff --git a/contents/textbook/questions/L1P1-Q1.md b/contents/textbook/questions/l1p1-q1.md similarity index 100% rename from contents/textbook/questions/L1P1-Q1.md rename to contents/textbook/questions/l1p1-q1.md diff --git a/contents/textbook/questions/L1P1-Q2.md b/contents/textbook/questions/l1p1-q2.md similarity index 100% rename from contents/textbook/questions/L1P1-Q2.md rename to contents/textbook/questions/l1p1-q2.md diff --git a/site.json b/site.json index 9318c54..91fd661 100644 --- a/site.json +++ b/site.json @@ -42,11 +42,11 @@ "title": "CS2103/T Textbook - Singleton Pattern" }, { - "src": "book/common/Definitions.md", + "src": "book/common/definitions.md", "title": "CS2103/T Textbook - Definitions" }, { - "src": "book/common/References.md", + "src": "book/common/references.md", "title": "CS2103/T Textbook - References" } ], From 56315f3f52a7f237a9cff937208a11fec02112bc Mon Sep 17 00:00:00 2001 From: rebekahlow-jy Date: Tue, 9 May 2017 15:45:20 +0800 Subject: [PATCH 2/6] Fix typo in URL --- book/se-pattern/introduction/apply.md | 2 +- book/se-pattern/singleton/apply.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/book/se-pattern/introduction/apply.md b/book/se-pattern/introduction/apply.md index 32463c5..e955b65 100644 --- a/book/se-pattern/introduction/apply.md +++ b/book/se-pattern/introduction/apply.md @@ -1 +1 @@ -* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/Learningoutcomes.md#apply-design-patterns-lo-designpatterns) +* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/LearningOutcomes.md#apply-design-patterns-lo-designpatterns) diff --git a/book/se-pattern/singleton/apply.md b/book/se-pattern/singleton/apply.md index 32463c5..e955b65 100644 --- a/book/se-pattern/singleton/apply.md +++ b/book/se-pattern/singleton/apply.md @@ -1 +1 @@ -* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/Learningoutcomes.md#apply-design-patterns-lo-designpatterns) +* :one: Do the exercise given in [SE-EDU: Addressbook Level 4: Apply Design Patterns](https://github.com/se-edu/addressbook-level4/blob/master/docs/LearningOutcomes.md#apply-design-patterns-lo-designpatterns) From 86a6667c403bdfb8760c1561b45b6bf9cc196768 Mon Sep 17 00:00:00 2001 From: rebekahlow-jy Date: Thu, 18 May 2017 18:00:53 +0800 Subject: [PATCH 3/6] Change MSS use case to HTML/CSS format --- book/requirements/useCases/css/useCases.css | 4 + .../useCases/details/mainSuccessScenario.md | 88 +++++++++++-------- 2 files changed, 56 insertions(+), 36 deletions(-) create mode 100644 book/requirements/useCases/css/useCases.css diff --git a/book/requirements/useCases/css/useCases.css b/book/requirements/useCases/css/useCases.css new file mode 100644 index 0000000..97c9c39 --- /dev/null +++ b/book/requirements/useCases/css/useCases.css @@ -0,0 +1,4 @@ +.custom-bullet-point { + list-style: none; + margin-left: -25px; +} diff --git a/book/requirements/useCases/details/mainSuccessScenario.md b/book/requirements/useCases/details/mainSuccessScenario.md index ffcf7f1..d90c0a5 100644 --- a/book/requirements/useCases/details/mainSuccessScenario.md +++ b/book/requirements/useCases/details/mainSuccessScenario.md @@ -1,43 +1,59 @@ + + The Main Success Scenario (MSS) describes the most straightforward interaction for a given use case, which assumes that nothing goes wrong. This is also called the _Basic Course of Action_ or the _Main Flow of Events_ of a use case. Given below is another example of an MSS. +
+
    +
  • System: Online Banking System (OBS)
    • +
  • Use case: UC23 - Transfer Money
    • +
  • Actor: User
    • +
  • MSS: +
      +
    1. User chooses to transfer money.
      2. +
    2. OBS requests for details of the transfer.
      3. +
    3. User enters the requested details.
      4. +
    4. OBS requests for confirmation.
      5. +
    5. OBS transfers the money and displays the new account balance.
      6. +
    6. Use case ends.
      7. +
    +
    • +
  • Extensions: +
      +
    1. 3a. OBS detects an error in the entered data. +
        +
      1. 3a1. OBS requests for the correct data.
        2. +
      2. 3a2. User enters new data.
        3. +
      3. Steps 3a1-3a2 are repeated until the data entered are correct.
        4. +
      4. Use case resumes from step 4.
        5. +
      +
      2. +
    2. 3b. User requests to effect the transfer in a future date. +
        +
      1. 3b1. OBS requests for confirmation.
        2. +
      2. 3b2. User confirms future transfer.
        3. +
      3. Use case ends.
        4. +
      +
      3. +
    3. *a. At any time, User chooses to cancel the transfer. +
        +
      1. *a1. OBS requests to confirm the cancellation.
        2. +
      2. *a2. User confirms the cancellation.
        3. +
      3. Use case ends.
        4. +
      +
      4. +
    4. *b. At any time, 120 seconds lapse without any input from the User. +
        +
      1. *b1. OBS cancels the transfer.
        2. +
      2. *b2. OBS informs the User of the cancellation.
        3. +
      3. Use case ends.
        4. +
      +
      5. +
    +
    • +
+
-``` -System: Online Banking System (OBS) -Use case: UC23 - Transfer Money -Actor: User -MSS: - 1. User chooses to transfer money. - 2. OBS requests for details of the transfer. - 3. User enters the requested details. - 4. OBS requests for confirmation. - 5. User confirms transfer. - 6. OBS transfers the money and displays the new account balance. - Use case ends. - -Extensions: - 3a. OBS detects an error in the entered data. - 3a1. OBS requests for the correct data. - 3a2. User enters new data. - Steps 3a1-3a2 are repeated until the data entered are correct. - Use case resumes from step 4. - - 3b. User requests to effect the transfer in a future date. - 3b1. OBS requests for confirmation. - 3b2. User confirms future transfer. - Use case ends. - - *a. At any time, User chooses to cancel the transfer - *a1. OBS requests to confirm the cancellation - *a2. User confirms the cancellation - Use case ends. - - *b. At any time, 120 seconds lapse without any input from the User - *b1. OBS cancels the transfer - *b2. OBS informs the User of the cancellation - Use case ends. - -``` Note how the MSS assumes that all entered details are correct and ignores problems such as timeouts, network outages etc. MSS does not tell us what happens if the user enters incorrect data. From 97f1f033c2a2750fb0c9ca98bd6b3582c97ad898 Mon Sep 17 00:00:00 2001 From: rebekahlow-jy Date: Fri, 19 May 2017 10:49:56 +0800 Subject: [PATCH 4/6] Change indentation spacing and CSS styling --- book/requirements/useCases/css/useCases.css | 9 +- .../useCases/details/mainSuccessScenario.md | 104 +++++++++--------- 2 files changed, 59 insertions(+), 54 deletions(-) diff --git a/book/requirements/useCases/css/useCases.css b/book/requirements/useCases/css/useCases.css index 97c9c39..dc76096 100644 --- a/book/requirements/useCases/css/useCases.css +++ b/book/requirements/useCases/css/useCases.css @@ -1,4 +1,9 @@ +.custom-bullet-list > li { + list-style: none; + margin-left: -25px; +} + .custom-bullet-point { - list-style: none; - margin-left: -25px; + list-style: none; + margin-left: -15px; } diff --git a/book/requirements/useCases/details/mainSuccessScenario.md b/book/requirements/useCases/details/mainSuccessScenario.md index d90c0a5..9fbddee 100644 --- a/book/requirements/useCases/details/mainSuccessScenario.md +++ b/book/requirements/useCases/details/mainSuccessScenario.md @@ -1,59 +1,59 @@ - + The Main Success Scenario (MSS) describes the most straightforward interaction for a given use case, which assumes that nothing goes wrong. This is also called the _Basic Course of Action_ or the _Main Flow of Events_ of a use case. Given below is another example of an MSS. -
-
    -
  • System: Online Banking System (OBS)
    • -
  • Use case: UC23 - Transfer Money
    • -
  • Actor: User
    • -
  • MSS: -
      -
    1. User chooses to transfer money.
      2. -
    2. OBS requests for details of the transfer.
      3. -
    3. User enters the requested details.
      4. -
    4. OBS requests for confirmation.
      5. -
    5. OBS transfers the money and displays the new account balance.
      6. -
    6. Use case ends.
      7. -
    -
    • -
  • Extensions: -
      -
    1. 3a. OBS detects an error in the entered data. -
        -
      1. 3a1. OBS requests for the correct data.
        2. -
      2. 3a2. User enters new data.
        3. -
      3. Steps 3a1-3a2 are repeated until the data entered are correct.
        4. -
      4. Use case resumes from step 4.
        5. -
      -
      2. -
    2. 3b. User requests to effect the transfer in a future date. -
        -
      1. 3b1. OBS requests for confirmation.
        2. -
      2. 3b2. User confirms future transfer.
        3. -
      3. Use case ends.
        4. -
      -
      3. -
    3. *a. At any time, User chooses to cancel the transfer. -
        -
      1. *a1. OBS requests to confirm the cancellation.
        2. -
      2. *a2. User confirms the cancellation.
        3. -
      3. Use case ends.
        4. -
      -
      4. -
    4. *b. At any time, 120 seconds lapse without any input from the User. -
        -
      1. *b1. OBS cancels the transfer.
        2. -
      2. *b2. OBS informs the User of the cancellation.
        3. -
      3. Use case ends.
        4. -
      -
      5. -
    -
    • -
-
+
+
    +
  • System: Online Banking System (OBS)
    • +
  • Use case: UC23 - Transfer Money
    • +
  • Actor: User
    • +
  • MSS: +
      +
    1. User chooses to transfer money.
      2. +
    2. OBS requests for details of the transfer.
      3. +
    3. User enters the requested details.
      4. +
    4. OBS requests for confirmation.
      5. +
    5. OBS transfers the money and displays the new account balance.
      6. +
    6. Use case ends.
      7. +
    +
    • +
  • Extensions: +
      +
    1. 3a. OBS detects an error in the entered data. +
        +
      1. 3a1. OBS requests for the correct data.
        2. +
      2. 3a2. User enters new data.
        3. +
      3. Steps 3a1-3a2 are repeated until the data entered are correct.
        4. +
      4. Use case resumes from step 4.
        5. +
      +
      2. +
    2. 3b. User requests to effect the transfer in a future date. +
        +
      1. 3b1. OBS requests for confirmation.
        2. +
      2. 3b2. User confirms future transfer.
        3. +
      3. Use case ends.
        4. +
      +
      3. +
    3. *a. At any time, User chooses to cancel the transfer. +
        +
      1. *a1. OBS requests to confirm the cancellation.
        2. +
      2. *a2. User confirms the cancellation.
        3. +
      3. Use case ends.
        4. +
      +
      4. +
    4. *b. At any time, 120 seconds lapse without any input from the User. +
        +
      1. *b1. OBS cancels the transfer.
        2. +
      2. *b2. OBS informs the User of the cancellation.
        3. +
      3. Use case ends.
        4. +
      +
      5. +
    +
    • +
+
-Note how the MSS assumes that all entered details are correct and ignores problems such as timeouts, network outages etc. MSS does not tell us what happens if the user enters incorrect data. + Note how the MSS assumes that all entered details are correct and ignores problems such as timeouts, network outages etc. MSS does not tell us what happens if the user enters incorrect data. From b9757ba472bf8369c6885ba2d2703142b9539ea8 Mon Sep 17 00:00:00 2001 From: rebekahlow-jy Date: Fri, 19 May 2017 11:15:01 +0800 Subject: [PATCH 5/6] Fix indentation spacing issues --- book/requirements/useCases/css/useCases.css | 6 +- .../useCases/details/mainSuccessScenario.md | 92 +++++++++---------- 2 files changed, 49 insertions(+), 49 deletions(-) diff --git a/book/requirements/useCases/css/useCases.css b/book/requirements/useCases/css/useCases.css index dc76096..7039971 100644 --- a/book/requirements/useCases/css/useCases.css +++ b/book/requirements/useCases/css/useCases.css @@ -1,9 +1,9 @@ .custom-bullet-list > li { - list-style: none; + list-style: none; margin-left: -25px; } .custom-bullet-point { - list-style: none; - margin-left: -15px; + list-style: none; + margin-left: -15px; } diff --git a/book/requirements/useCases/details/mainSuccessScenario.md b/book/requirements/useCases/details/mainSuccessScenario.md index 9fbddee..415aab4 100644 --- a/book/requirements/useCases/details/mainSuccessScenario.md +++ b/book/requirements/useCases/details/mainSuccessScenario.md @@ -5,53 +5,53 @@ The Main Success Scenario (MSS) describes the most straightforward interaction f
    -
  • System: Online Banking System (OBS)
    • -
  • Use case: UC23 - Transfer Money
    • -
  • Actor: User
    • -
  • MSS: -
      -
    1. User chooses to transfer money.
      2. -
    2. OBS requests for details of the transfer.
      3. -
    3. User enters the requested details.
      4. -
    4. OBS requests for confirmation.
      5. -
    5. OBS transfers the money and displays the new account balance.
      6. -
    6. Use case ends.
      7. -
    -
    • -
  • Extensions: -
      -
    1. 3a. OBS detects an error in the entered data. -
        -
      1. 3a1. OBS requests for the correct data.
        2. -
      2. 3a2. User enters new data.
        3. -
      3. Steps 3a1-3a2 are repeated until the data entered are correct.
        4. -
      4. Use case resumes from step 4.
        5. -
      -
      2. -
    2. 3b. User requests to effect the transfer in a future date. -
        -
      1. 3b1. OBS requests for confirmation.
        2. -
      2. 3b2. User confirms future transfer.
        3. -
      3. Use case ends.
        4. -
      -
      3. -
    3. *a. At any time, User chooses to cancel the transfer. -
        -
      1. *a1. OBS requests to confirm the cancellation.
        2. -
      2. *a2. User confirms the cancellation.
        3. -
      3. Use case ends.
        4. -
      -
      4. -
    4. *b. At any time, 120 seconds lapse without any input from the User. -
        -
      1. *b1. OBS cancels the transfer.
        2. -
      2. *b2. OBS informs the User of the cancellation.
        3. -
      3. Use case ends.
        4. -
      -
      5. -
    +
  • System: Online Banking System (OBS)
    • +
  • Use case: UC23 - Transfer Money
    • +
  • Actor: User
    • +
  • MSS: +
      +
    1. User chooses to transfer money.
      2. +
    2. OBS requests for details of the transfer.
      3. +
    3. User enters the requested details.
      4. +
    4. OBS requests for confirmation.
      5. +
    5. OBS transfers the money and displays the new account balance.
      6. +
    6. Use case ends.
      7. +
    • -
+
  • Extensions: +
      +
    1. 3a. OBS detects an error in the entered data. +
        +
      1. 3a1. OBS requests for the correct data.
        2. +
      2. 3a2. User enters new data.
        3. +
      3. Steps 3a1-3a2 are repeated until the data entered are correct.
        4. +
      4. Use case resumes from step 4.
        5. +
      +
      2. +
    2. 3b. User requests to effect the transfer in a future date. +
        +
      1. 3b1. OBS requests for confirmation.
        2. +
      2. 3b2. User confirms future transfer.
        3. +
      3. Use case ends.
        4. +
      +
      3. +
    3. *a. At any time, User chooses to cancel the transfer. +
        +
      1. *a1. OBS requests to confirm the cancellation.
        2. +
      2. *a2. User confirms the cancellation.
        3. +
      3. Use case ends.
        4. +
      +
      4. +
    4. *b. At any time, 120 seconds lapse without any input from the User. +
        +
      1. *b1. OBS cancels the transfer.
        2. +
      2. *b2. OBS informs the User of the cancellation.
        3. +
      3. Use case ends.
        4. +
      +
      5. +
    +
    • +
    Note how the MSS assumes that all entered details are correct and ignores problems such as timeouts, network outages etc. MSS does not tell us what happens if the user enters incorrect data. From fb79b46709adb2d2db41a1c926a58e8fb323e135 Mon Sep 17 00:00:00 2001 From: rebekahlow-jy Date: Fri, 19 May 2017 13:20:12 +0800 Subject: [PATCH 6/6] Shift useCases.css to /book/css folder --- book/{requirements/useCases => }/css/useCases.css | 0 book/requirements/useCases/details/mainSuccessScenario.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename book/{requirements/useCases => }/css/useCases.css (100%) diff --git a/book/requirements/useCases/css/useCases.css b/book/css/useCases.css similarity index 100% rename from book/requirements/useCases/css/useCases.css rename to book/css/useCases.css diff --git a/book/requirements/useCases/details/mainSuccessScenario.md b/book/requirements/useCases/details/mainSuccessScenario.md index 415aab4..17d192d 100644 --- a/book/requirements/useCases/details/mainSuccessScenario.md +++ b/book/requirements/useCases/details/mainSuccessScenario.md @@ -1,4 +1,4 @@ - + The Main Success Scenario (MSS) describes the most straightforward interaction for a given use case, which assumes that nothing goes wrong. This is also called the _Basic Course of Action_ or the _Main Flow of Events_ of a use case. Given below is another example of an MSS.