Difference between revisions of "Digital Journal"
Line 55: | Line 55: | ||
{{ConsoleLine|john-williams@codermerlin:~/Digital Portfolio/CS-I/Journals$ |}} | {{ConsoleLine|john-williams@codermerlin:~/Digital Portfolio/CS-I/Journals$ |}} | ||
We'll be using HTML files for your journals. You will name each file in accordance with the identifier of the experience (with the "W" replaced by a "J") with an extension of ".html". | We'll be using HTML files for your journals. You will name each file in accordance with the identifier of the experience (with the "W" replaced by a "J") with an extension of ".html". | ||
== Template == | == Template == |
Revision as of 17:04, 28 August 2022
Curriculum[edit]
Coder Merlin™ Computer Science Curriculum Data | |
Unit: Lab basics Experience Name: Digital Journal (W1005) Next Experience: () Knowledge and skills:
Topic areas: Reflection Classroom time (average): 20 minutes Study time (average): 30 minutes Successful completion requires knowledge: understand the purpose of a digital journal; understand the purpose of reflection Successful completion requires skills: creating a digital journal in the proper format |
Background[edit]
Introduction[edit]
Your journey through these computer science experiences will benefit greatly by journaling. Each journal entry will have these parts:
- A brief journal header
- The second part of your journal will document assistance that you have received or provided.
- The third part of your journal will have a prescribed format. Here, you'll have the opportunity to ponder phenomena that you've observed and answer some questions.
- The fourth part of your journal entry will address some open-ended prompts that will be the same for each experience.
- The final part is your opportunity to further explore the experience on your own.
Your journals will be one component of your Digital Portfolio; we'll set that up next.
Create your Digital Portfolio on the Server[edit]
1. Create a new directory called Digital Portfolio in your home directory.
jane-williams@codermerlin:~$ cd
jane-williams@codermerlin:~$ mkdir "Digital Portfolio"
2. Create a link to the new directory from your www directory, which is the only directory from which your web server will serve files.
jane-williams@codermerlin:~$ cd ~/www
jane-williams@codermerlin:~/www$ ln -s ~/Digital\ Portfolio "Digital Portfolio"
3. By default, other users, including the web server itself, will not have access to your directories and files. However, in this case, we do want to expose our journals to the web server. To do so, create a file to set the permissions to allow the web server read access to the files and traverse access to the directories.
jane-williams@codermerlin:~/www$ emacs setPermissions.sh
Into this file, add the following:
#!/bin/bash
# Allow this and descenant directories to be traversed by everyone, ignoring hidden directories
find -L "$PWD" -not -path "*/.*" -type d -exec chmod a+X {} \;
# Allow everyone read access to all files in this hierarchy with an extension of
# .html, .png, or .jpg
find -L "$PWD" -not -path "*/.*" -type f \( -name "*.html" -o -name "*.png" -o -name "*.jpg" \) -exec chmod a+r {} \;
Save the file and exit emacs.
Set the permissions of this file:
jane-williams@codermerlin:~/www$ chmod u+x setPermissions.sh
4. Any time you add a new file, execute the script:
jane-williams@codermerlin:~/www$ ./setPermissions.sh
Conventions[edit]
Journal Location and Name[edit]
All of your journals will be located in a subdirectory called "Journals" under your current class in your "Digital Portfolio" directory. Let's create that directory now.
john-williams@codermerlin:~$ cd ~/"Digital Portfolio"
john-williams@codermerlin:~/Digital Portfolio$ mkdir -p CS-I/Journals
john-williams@codermerlin:~/Digital Portfolio$ cd CS-I/Journals
john-williams@codermerlin:~/Digital Portfolio/CS-I/Journals$
We'll be using HTML files for your journals. You will name each file in accordance with the identifier of the experience (with the "W" replaced by a "J") with an extension of ".html".
Template[edit]
To quickly create journals, you can copy this text into emacs into a file inside your Journals directory called "Template.html". Then, to start a new journal, copy the template as a starting point.
jane-williams@codermerlin:~/Digital Portfolio/CS-I/Journals$ emacs Template.html
Then, copy the text below into emacs:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>CS-I Journal J1002</title>
</head>
<body>
<h1>CS-I Journal J1002: Shell</h1>
<p>Name: Jane Williams</p>
<p>Date: 28-Aug-2022</p>
<p>I received assistance from: John Williams</p>
<p>I assisted: Cameron Delgado</p>
<h2>Section 1</h2>
<h3>Question 1: This is the first question in section 1.</h3>
<p>This is an answer in the format of a full sentence.</p>
<h2>Section 2</h2>
<h3>Question 1: This is the first question in section 2.</h3>
<p>This is an answer in the format of a full sentence.</p>
<h3>Question 2: This is the second question in section 2.</h3>
<p>This is an answer in the format of a full sentence.</p>
<h2>What did I learn? What is the "big idea"?</h2>
<p>I learned that...</p>
<h2>What challenges did I encounter?</h2>
<p>I encountered challlenges when...</p>
<h2>How could this experience be improved?</h2>
<p>This experience could be improved by...</p>
<h2>Free Reflection: How has what I've learned affected my thinking?</h2>
<p>I now realize that...</p>
</body>
</html>
Before saving the file, change the name of the author to your name. Then save the file.
Now, the next time that you need a journal, copy the template as a starting point. For example:
jane-williams@codermerlin:~/Journals$ cp Template.html Jnnnn.html
Journaling Requirements[edit]
- The first part of your journal will be a simple header with your name, the journal identifier, and the date that you started writing the journal. Type that into emacs now:
1 | Name: Jane Williams
2 | Journal: J1002
3 | Date: 4-May-2024
4 |
5 |
- The second part of your journal simply lists the individuals who have provided you with assistance and those who you yourself have assisted:
4 |
5 |
6 | I received assistance from: John Williams
7 |
8 | I assisted: Jane Williams
9 |
Providing clear attribution when using the ideas and creations of others is a core tenet of your journey and a serious responsibility. Do not leave these lines relating to assistance blank. You must either list one or more names or explicitly state NO ONE.
- The third part of your journal will have a prescribed format, as determined by the specific observation boxes in that experience. As an example, consider the following two boxes from W1002:
- Name at least two other services that you personally use that are implemented using a Client/Server Model
- It appears that both Jack Williams and John Williams can have a directory of the same name. Do you think the ability to have two different users create a directory of the same name is important? Why?
These questions should be labeled in your journal using the convention Section.Question followed by a newline character. Use complete sentences and leave a blank line between questions. In this example, there are two sections with one question in each section. In emacs, we'd continue as follows:
8 |
9 | 1.1:
10 | One of the other services that I use is...
11 | Another of the services that I use is...
12 |
13 | 2.1:
14 | I think that the ability to have two different users...
- The fourth section will address some questions that require a bit more thought. These same questions will be answered for each experience. Let's add these lines to emacs now:
15 |
16 | What did I learn? What is the "big idea"?
17 |
18 | What challenges did I encounter?
19 |
20 | How could this experience be improved?
21 |
- The final part of your journal is titled "Free Reflection." It's an opportunity for you to reflect on your experience and how it has affected your thinking. Let's add these lines to emacs now:
21 |
22 | Free Reflection: How has what I've learned affected my thinking?
23 |
Exercises[edit]
Now that you've completed W1005, complete:
- J1002 Create a journal and answer all questions in W1002. Be sure to include all sections of the journal, properly formatted.
Experience Metadata
Experience ID | W1005 |
---|---|
Next experience ID | |
Unit | Lab basics |
Knowledge and skills | §10.111 §10.112 §10.121 §10.651 |
Topic areas | Reflection |
Classroom time | 20 minutes |
Study time | 30 minutes |
Acquired knowledge | understand the purpose of a digital journal understand the purpose of reflection |
Acquired skill | creating a digital journal in the proper format |
Additional categories |