diff --git a/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-clippy.tid b/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-clippy.tid new file mode 100644 index 0000000..9eb17cb --- /dev/null +++ b/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-clippy.tid @@ -0,0 +1,5 @@ +tags: clipart $:/tags/Image +title: $:/ou/clipart/octoicons/octicon-clippy +type: text/vnd.tiddlywiki + + diff --git a/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-cloud-download.tid b/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-cloud-download.tid new file mode 100644 index 0000000..2523c18 --- /dev/null +++ b/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-cloud-download.tid @@ -0,0 +1,5 @@ +tags: clipart $:/tags/Image +title: $:/ou/clipart/octoicons/octicon-cloud-download +type: text/vnd.tiddlywiki + + \ No newline at end of file diff --git a/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-plus.tid b/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-plus.tid new file mode 100644 index 0000000..5b503a2 --- /dev/null +++ b/tiddlers/content/clipart/octoicons/$__ou_clipart_octoicons_octicon-plus.tid @@ -0,0 +1,5 @@ +tags: clipart $:/tags/Image +title: $:/ou/clipart/octoicons/octicon-plus +type: text/vnd.tiddlywiki + + \ No newline at end of file diff --git a/tiddlers/content/labs/lab01/_Labs_01_Appendix_ Keyboard Navigation Shortcuts.md b/tiddlers/content/labs/lab01/_Labs_01_Appendix_ Keyboard Navigation Shortcuts.md deleted file mode 100644 index f05d4da..0000000 --- a/tiddlers/content/labs/lab01/_Labs_01_Appendix_ Keyboard Navigation Shortcuts.md +++ /dev/null @@ -1,57 +0,0 @@ -The following are the keyboard navigation shortcuts that you were shown during the lab. - -Note that the following keys: <>,<>, <>, and <>, are referring to the arrow keys on your keyboard. - -Move by word: - ~ Windows / Linux: < 🠘 or 🠚">> - - Mac: < 🠘 or 🠚">> - - Hold down <> at the same time to select the word (or multiple words). - -Delete word to left of cursor: - ~ Windows / Linux: < Backspace">> - - Mac: < Delete">> - -Delete word to right of cursor: - ~ Windows / Linux: < Delete">> - - Mac: < Option > Delete">> - -Jump to start or end of the current line: - ~ Windows / Linux: <> or <> - - Mac: < 🠘 or 🠚">> - - Hold down <> to select from the current cursor position. - -Jump to top or bottom of current page/screen (varies by application): - ~ Windows / Linux: <> or <> - - Mac: < 🠙 or 🠛">> - - Hold down <> to select from the current cursor position. - -Jump to top or bottom of file/document: - ~ Windows / Linux: < Home">> or < End">> - - Mac: < 🠙 or 🠛">> - - Hold down <> to select from the current cursor position. - -Try to get into the habit of using keyboard shortcuts when editing text rather than reaching for the mouse. You will be a lot more efficient that way. - -## Mac Finder Shortcuts - -These are useful features that have no corresponding buttons or menus (or these features are hidden by default) so knowing the shortcut keys is very useful. - -Go to home: < Shift > H ">> - -Go to specific path: < Shift > G ">> - -Go to parent: < 🠙">> - -Toggle hidden files/folders: < Shift > .">> - -Create new file/folder: < Shift > N">> diff --git a/tiddlers/content/labs/lab01/_Labs_01_Appendix_ Keyboard Navigation Shortcuts.md.meta b/tiddlers/content/labs/lab01/_Labs_01_Appendix_ Keyboard Navigation Shortcuts.md.meta deleted file mode 100644 index 7a15bbf..0000000 --- a/tiddlers/content/labs/lab01/_Labs_01_Appendix_ Keyboard Navigation Shortcuts.md.meta +++ /dev/null @@ -1,6 +0,0 @@ -created: 20200705192108058 -modified: 20200706221205870 -section: 8 -tags: lab01 lab -title: /Labs/01/Appendix: Keyboard Navigation Shortcuts -type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md b/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md index 1b9eaef..91a9b51 100644 --- a/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md +++ b/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md @@ -6,7 +6,7 @@ * If we want you to enter a keyboard shortcut command: < Space">>. -* When we are referring to paths or folders/files on disk it will look like: <>. +* When we are referring to paths to folders on disk it will look like: <>. If we are refering to paths to files on disk it will look like <>. * Blocks of code look like: @@ -16,9 +16,9 @@ } ``` -* Many operations in NetBeans are performed by right clicking the root folder of the project in the project pane. This will be abbreviated to <> which is short for 'right click the project'. +* Many operations in NetBeans are performed by right clicking the root folder of the project in the project pane (it usually has the little elephant icon). This will be abbreviated to <> which is short for 'right click the project'. -* We will often describe a task that needs to be completed and then provide additional details on how you should go about completing that task. Students sometimes get confused because they stop at the "what" part of the task, before getting to the "how" part. If something is confusing then keep reading — you might not have got to the "how" part yet. +* We will often briefly describe a task that needs to be completed and then provide additional details on how you should go about completing that task. Students sometimes get confused because they stop at the "what" part of the task, before getting to the "how" part. If something is confusing then keep reading — you might not have got to the "how" part yet. * The INFO202 lab documents can be quite long. diff --git a/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md.meta b/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md.meta index 24e6b34..876977b 100644 --- a/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md.meta +++ b/tiddlers/content/labs/lab01/_Labs_01_Document Conventions.md.meta @@ -1,6 +1,6 @@ created: 20200703064817063 modified: 20200706221031394 -section: 1.4 +section: 1.2 tags: lab01 lab title: /Labs/01/Document Conventions -type: text/x-markdown +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/content/labs/lab01/_Labs_01_Introduction.tid b/tiddlers/content/labs/lab01/_Labs_01_Introduction.tid index d30805c..6151bc3 100644 --- a/tiddlers/content/labs/lab01/_Labs_01_Introduction.tid +++ b/tiddlers/content/labs/lab01/_Labs_01_Introduction.tid @@ -7,4 +7,8 @@ Welcome to INFO202. In this course we will build on the knowledge that you gained in previous courses (primarily COMP101, COMP160/161, and INFO201) to show you how you can create large (compared to what you have done previously) business applications. -This lab is about reintroducing you to some of the tools that we used in INFO201. \ No newline at end of file +This lab is about reintroducing you to some of the tools that we used in INFO201. + +First things first, take a quick look at <>, to remind youself of how to work with this document. + +If you already have a functional version of NetBeans and VS Code with the Markdown and PlantUML plugins then you are good to go. If not, take a look at <> to get everything that you need installed on your own computer. We would prefer that you use the Linux machines during the lab sessions, but it is important that you are able to use your own computers to work on the project when you don't have easy access to the Linux computers. \ No newline at end of file diff --git a/tiddlers/content/labs/lab01/_Labs_01_Linux Desktop.tid b/tiddlers/content/labs/lab01/_Labs_01_Linux Desktop.tid index 9df5381..90e53eb 100644 --- a/tiddlers/content/labs/lab01/_Labs_01_Linux Desktop.tid +++ b/tiddlers/content/labs/lab01/_Labs_01_Linux Desktop.tid @@ -1,11 +1,11 @@ created: 20200703045728499 modified: 20200706221021686 -section: 1.3 +section: 1.1 tags: lab01 lab title: /Labs/01/Linux Desktop type: text/vnd.tiddlywiki -We will be using the Information Science Linux desktop in labs OBS 3.27 and North CAL for INFO202. +We will be using the Information Science Linux desktop in labs OBS 3.26/3.27 and North CAL for INFO202. If you are reading this document from the Windows desktop then reboot and choose the 'Information Science Linux Desktop' option from the boot menu. You can log in with your usual University username and password. @@ -15,10 +15,10 @@ * We have more control over the software. We often need to make changes to software during the semester and it can take a long time to go through ITS to make these changes happen in the Windows student desktop. -One downside of using our own Linux desktop is that you currently only have access to it from labs OBS 3.27 and North CAL . We will make sure that you are able to continue working on the Windows student desktop when you don't have access to the labs OBS 3.27 or North CAL. NetBeans, Gradle, VS Code, and most of the other software that we will be using will also be available to you in the student desktop. Most of you will have NetBeans, Gradle, and VS Code installed on your own computers as a result of taking INFO201, so you can continue to use that in INFO202. Note that NetBeans 12.4 was released a few weeks ago --- we have found that version to be a bit buggy, so don't bother upgrading to that version --- whatever worked for you last semester will work again this semester. +One downside of using our own Linux desktop is that you currently only have access to it from labs OBS 3.26/3.27 and North CAL. This is why we get you to install everything that you need on your own computers. As a last resort, we do have versions of everything that you need installed in the Windows student desktop, but you should consider this to be a last resort since the performance is not great. There is some information in the reference section of the document that describes how to access the software in the student desktop if you need to. Take a couple of minutes to read the 'Lab Information' document on your desktop to refamiliarise yourself with the Linux environment. Pay particular attention to the following sections since they contain information that you should be aware of: * Home Folder -* Accessing your H: Drive (note that this is currently very unreliable --- we are working on determining what the problem is). +* Accessing your H: Drive * Printing diff --git a/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md b/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md index dbbd28a..84cad3e 100644 --- a/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md +++ b/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md @@ -1,4 +1,4 @@ -The following are the naming conventions that we want you to use in INFO202. The Java conventions are industry-wide conventions. The other conventions are to help you to avoid common problems with conflicting bits of software. +The following are the naming conventions that we want you to use in {{$:/ou/parameters/Paper Code}}. The Java conventions are industry-wide conventions. The other conventions are to help you to avoid common problems with conflicting bits of software. * Project folders should be single-word (no spaces) and entirely lowercase. @@ -8,7 +8,9 @@ Also remember that Java is case-sensitive and both Windows and macOS only pretend to be case-sensitive. This can cause some weird problems, particularly when you rename folders, so the easiest way to avoid those problems is to stick to all-lower case for folder names. Linux file systems are usually case sensitive, so we can avoid a lot of weird problems by using Linux, however the network file servers that we are using are not-case sensitive, so we still have to be careful. - Please also consider if the parent folder that you are putting your projects into contains any spaces. Putting your projects into the <> folder on Windows is a bad idea for the reasons mentioned above. + Please also consider if the parent folder that you are putting your projects into contains any spaces. It doesn't matter if you are careful with your project folder names if you are storing them in a folder named <>. + + Also, try to avoid putting your project folders into folders that are managed by iCloud, or OneDrive (or any other cloud-synced folder). Cloud based file systems do the bare minimum that they can to back up your files and allow you to open them --- they are not complete files systems. Development tools like IDEs expect to get notified when a file gets updated and cloud based files systems don't do this --- lots of things break if you store your development projects in a cloud-synced folder. You will be using GitBucket for storing all of your projects in this course, so GitBucket will act as both a remote backup, and give you a way to access your files if aren't near your computer. * Java classes and interfaces should **always** start with an uppercase letter (which makes them easily distinguishable from other identifiers in your source code). diff --git a/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md.meta b/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md.meta index 6177d34..026624c 100644 --- a/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md.meta +++ b/tiddlers/content/labs/lab01/_Labs_01_Naming Conventions.md.meta @@ -3,4 +3,4 @@ section: 2 tags: lab01 lab title: /Labs/01/Naming Conventions -type: text/x-markdown +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/content/labs/lab01/_Labs_01_TiddlyWiki.tid b/tiddlers/content/labs/lab01/_Labs_01_TiddlyWiki.tid deleted file mode 100644 index 24ac6a3..0000000 --- a/tiddlers/content/labs/lab01/_Labs_01_TiddlyWiki.tid +++ /dev/null @@ -1,26 +0,0 @@ -created: 20200702113016814 -modified: 20200706234329045 -section: 1.2 -tags: lab01 lab -title: /Labs/01/TiddlyWiki -type: text/vnd.tiddlywiki - -We will be using TiddlyWiki for delivering the lab content in INFO202. You saw this in INFO201 so the following is a quick refresher: - -* When you have completed a section you can close it with the <> button at the top right of each section. - -* You can save the current state of your progress by clicking the <> button on the side bar to the right. This will change the URL to include the state which you can then bookmark. If you open the bookmark the page will reappear in the exact state that you left it in. - -* You can reset back to the original state using the <> button on the side bar on the right. This will close all open sections, so you will lose your progress. - -* You can reopen a closed section by clicking its link in the 'Contents' section for that lab, or use the 'Contents' tab in the side bar. - -* There is a search box in the side bar on the right that can search the entire document. - -* If you want a printed copy of this document, first reset the document back to its default state by clicking the <> home button and then the <> button to open all of the sections, then click the <> button on the side bar on the right to print the document in is current state. - -* You can show and hide the side bar to make more room for the content using the <> button at the very top right of the document. - -* If you prefer a dark theme then click the <> button on the side bar. You can click the <> to switch back to the light theme. - -* You can download a copy of this document for offline use using the <> button on the side bar on the right. Note that this is the only proper way to save the document. Using the browser's 'save page' feature will likely result in a corrupted document. The file is completely self-contained, so the single HTML file that is downloaded contains the entire document at this point in time --- we will add more to this document as the semester progresses. You should be able to open the downloaded file in your browser by double clicking it in your file browser. \ No newline at end of file diff --git a/tiddlers/content/metadata/$__DefaultTiddlers.tid b/tiddlers/content/metadata/$__DefaultTiddlers.tid new file mode 100644 index 0000000..4aa6ed7 --- /dev/null +++ b/tiddlers/content/metadata/$__DefaultTiddlers.tid @@ -0,0 +1,4 @@ +title: $:/DefaultTiddlers +type: text/vnd.tiddlywiki + +/Coursework diff --git a/tiddlers/content/metadata/$__SiteSubtitle.tid b/tiddlers/content/metadata/$__SiteSubtitle.tid new file mode 100644 index 0000000..2efe1ca --- /dev/null +++ b/tiddlers/content/metadata/$__SiteSubtitle.tid @@ -0,0 +1,4 @@ +title: $:/SiteSubtitle +type: text/vnd.tiddlywiki + +Coursework diff --git a/tiddlers/content/metadata/$__SiteTitle.tid b/tiddlers/content/metadata/$__SiteTitle.tid new file mode 100644 index 0000000..5502ec9 --- /dev/null +++ b/tiddlers/content/metadata/$__SiteTitle.tid @@ -0,0 +1,4 @@ +title: $:/SiteTitle +type: text/vnd.tiddlywiki + +{{$:/ou/parameters/Paper Code}} diff --git a/tiddlers/content/parameters/$__ou_parameters_DBeaver Version.tid b/tiddlers/content/parameters/$__ou_parameters_DBeaver Version.tid new file mode 100644 index 0000000..e7f3842 --- /dev/null +++ b/tiddlers/content/parameters/$__ou_parameters_DBeaver Version.tid @@ -0,0 +1,6 @@ +caption: To Do +tags: +title: $:/ou/parameters/DBeaver Version +type: text/vnd.tiddlywiki + +21 \ No newline at end of file diff --git a/tiddlers/content/parameters/$__ou_parameters_Paper Code.tid b/tiddlers/content/parameters/$__ou_parameters_Paper Code.tid new file mode 100644 index 0000000..6a38cbb --- /dev/null +++ b/tiddlers/content/parameters/$__ou_parameters_Paper Code.tid @@ -0,0 +1,4 @@ +title: $:/ou/parameters/Paper Code +type: text/vnd.tiddlywiki + +INFO 202 diff --git a/tiddlers/content/reference/Software/_Reference_Software_Citrix Workspace.md b/tiddlers/content/reference/Software/_Reference_Software_Citrix Workspace.md new file mode 100644 index 0000000..87386ca --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Citrix Workspace.md @@ -0,0 +1,3 @@ +You will need to use Citrix Workspace to access the Windows student desktop lab environment from your own personal computers. If you haven't installed the Citrix Workspace on your own computer yet, then refer to the following page for installation instructions: + +https://blogs.otago.ac.nz/studentit/student-desktop/student-desktop-own-device/ \ No newline at end of file diff --git a/tiddlers/content/reference/Software/_Reference_Software_Citrix Workspace.md.meta b/tiddlers/content/reference/Software/_Reference_Software_Citrix Workspace.md.meta new file mode 100644 index 0000000..b86f37b --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Citrix Workspace.md.meta @@ -0,0 +1,3 @@ +tags: reference toc +title: /Reference/Software/Citrix Workspace +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/content/reference/Software/_Reference_Software_Software Used in INFO202.md b/tiddlers/content/reference/Software/_Reference_Software_Software Used in INFO202.md new file mode 100644 index 0000000..67ebc31 --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Software Used in INFO202.md @@ -0,0 +1,82 @@ +Many of you will already have the following software already installed as a result of taking INFO201. There is no need to reinstall anything if this is the case. + +We will be using the following software in {{$:/ou/parameters/Paper Code}}: + +* Java JDK 17. Mac users should use OpenJDK. Windows users should use Adoptium Temurin. + +
<> Don't install JDK 18 or newer. JDK 17 is the latest LTS (long term support) release, and is pretty much guaranteed to work with any recent versions of other software. JDK 18 is too new, and you will likely have problems with other software if you install this version (or a newer version).
+ +* Apache NetBeans 12.6 or newer. NetBeans 14 was recently released --- if you are installing from scratch then you might as well install the latest version. + +* Visual Studio Code (plus certain plugins --- see below for the plugin details) + +* Git version control system. + +* A capable text editor that can easily be used as the Git editor (e.g. TextMate on macOS). Notepad is OK on Windows. We just needs something that can quickly edit text without getting in the way or corrupting the text (TextEdit on Mac **will** screw up your files). + +# Package Managers + +We recommend that you use a package manager for installing software. Windows users can use Chocolatey, and Mac users can use Homebrew, + + There are some screencasts on Blackboard that show you how to install and use a package manager. + +## Windows/Chocolately + +To install via Chocolately on Windows (watch the screencast on Blackboard if you don't know what Chocolately is): + +```plaintext +choco install temurin17 +choco install apache-netbeans.portable +choco install vscode +choco install git +``` + +NetBeans has trouble finding the JDK by default, so watch the screencast to see how to fix this problem. + +Stoplight Studio is currently not available via Chocolately, so Windows users can manually download the installer from: https://stoplight.io/studio/ + +## macOS/Homebrew + +To install via Homebrew on macOS (watch the screencast on Blackboard if you don't know what Homebrew is): + +```plaintext +brew install openjdk@17 +brew install netbeans +brew install visual-studio-code +brew install git +brew install textmate +``` + +## Linux + +Note that this applies to your own computers only --- the Information Science Linux Desktop in labs OBS 3.26, OBS 3.27, and North CAL already have all of the required software installed. + +Use the built-in package manager. Depending on what distribution you are using, most of the above software should be available. Mark can help with this if you get stuck. Make sure that you install JDK 17 rather than something newer. + + +## VS Code Plugins + +You will need to install and configure a couple of additional plugins for Visual Studio Code. Start by running VS Code, then click the Extensions button at left (three squares with one removed). You can then search for and install the following plugins: + +* Markdown All in One (by Yu Zhang) + +* PlantUML (by Jebbs) + +We also need to make a couple of configuration changes to the two VS Code plugins to make them work effectively. Open the settings from the main menu (Windows/Linux: < Preferences > Settings">>, Mac: < Preferences > Settings">>). Use the search box in the settings window to find and update the following settings as itemised below (if the settings for a newly installed plugin don't appear, restart VS Code): + +* So that the preview window for the Markdown plugin appears automatically (since it is tricky to find the menu item to do this): + + Search for `markdown.extension.preview.autoShowPreviewToSide`. + + Check the box. + +* The PlantUML plugin will default to using your own computer for drawing the diagrams. While this should work out of the box, you will find that it can take a while to spin up the GraphVis component that performs the layout, and the Java Virtual Machine that runs PlantUML. Therefore, we suggest that you configure the plugin to use a remote server to draw the diagrams. In VS Code: + + * Search for `plantuml.render`. Change the setting from `Local` to `PlantUMLServer`. + + * Search for `plantuml.server`, and add the following value: + + ``` + https://isgb.otago.ac.nz/plantuml + ``` + Note that this is a server that we control. You can also use the "official" PlantUML server if you wish. The URL for that server is listed in the setting description. \ No newline at end of file diff --git a/tiddlers/content/reference/Software/_Reference_Software_Software Used in INFO202.md.meta b/tiddlers/content/reference/Software/_Reference_Software_Software Used in INFO202.md.meta new file mode 100644 index 0000000..377bc58 --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Software Used in INFO202.md.meta @@ -0,0 +1,3 @@ +tags: toc reference +title: /Reference/Software/Software Used in INFO202 +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/content/reference/Software/_Reference_Software_Using the TiddlyWiki.md b/tiddlers/content/reference/Software/_Reference_Software_Using the TiddlyWiki.md new file mode 100644 index 0000000..f5a42fd --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Using the TiddlyWiki.md @@ -0,0 +1,23 @@ +We will be using TiddlyWiki for delivering the lab content in INFO202. You saw this in INFO201 so the following is a quick refresher: + +* When you have completed a section you can close it with the <> button at the top right of each section. + +* You can save the current state of your progress by clicking the <> button on the side bar to the right. This will change the URL to include the state which you can then bookmark. If you open the bookmark the page will reappear in the exact state that you left it in. + +* You can reset back to the original state using the <> button on the side bar on the right. This will close all open sections, so you will lose your progress. + +* You can reopen a closed section by clicking its link in the 'Contents' section for that lab, or use the 'Contents' tab in the side bar. + +* There is a search box in the side bar on the right that can search the entire document. + +* If you want a printed copy of this document, first reset the document back to its default state by clicking the <> home button, then click the link for the lab that you want to print, then click the <> button to open all of the sections, and finally click the <> button on the side bar on the right to print the document in is current state. + +* You can show and hide the side bar to make more room for the content using the <> button at the very top right of the document. + +* If you prefer a dark theme then click the <> button on the side bar. We try to make the document fully viewable in both the dark and light themes, so if you notice that something is broken in the dark theme then let us know. + + You can click the <> button to switch back to the light theme. + +* You can download a copy of this document for offline use using the <> button on the side bar on the right. Note that this is the only proper way to save the document. Using the browser's 'save page' feature will likely result in a corrupted document. The file is completely self-contained, so the single HTML file that is downloaded contains the entire document at this point in time. You should be able to open the downloaded file in your browser by double clicking it in your file browser. + + We will add more to this document as the semester progresses, so stick to the online version of the document unless you do need to work offline. diff --git a/tiddlers/content/reference/Software/_Reference_Software_Using the TiddlyWiki.md.meta b/tiddlers/content/reference/Software/_Reference_Software_Using the TiddlyWiki.md.meta new file mode 100644 index 0000000..9289d40 --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Using the TiddlyWiki.md.meta @@ -0,0 +1,3 @@ +tags: toc reference +title: /Reference/Software/Using the TiddlyWiki +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/content/reference/Software/_Reference_Software_Using the Windows Student Desktop.md b/tiddlers/content/reference/Software/_Reference_Software_Using the Windows Student Desktop.md new file mode 100644 index 0000000..eff87f7 --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Using the Windows Student Desktop.md @@ -0,0 +1,11 @@ +If you are working from off-campus, you will need to use <> to access the student desktop. Otherwise, all of the computers in the CAL labs are able to access the Windows student desktop. + +Once you have logged into the student desktop, you should do the following to get access the relevant software: + +1. Navigate to <> via the file manager. + +1. Run the <> script by double clicking it. + + This will create a folder in the <> menu named <>. + + You will find shortcuts to all of the relevant software in that folder. diff --git a/tiddlers/content/reference/Software/_Reference_Software_Using the Windows Student Desktop.md.meta b/tiddlers/content/reference/Software/_Reference_Software_Using the Windows Student Desktop.md.meta new file mode 100644 index 0000000..a32414f --- /dev/null +++ b/tiddlers/content/reference/Software/_Reference_Software_Using the Windows Student Desktop.md.meta @@ -0,0 +1,3 @@ +tags: toc reference +title: /Reference/Software/Using the Windows Student Desktop +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/content/reference/TipsAndTricks/_Reference_Tips & Tricks_Keyboard & Mouse Shortcuts.md b/tiddlers/content/reference/TipsAndTricks/_Reference_Tips & Tricks_Keyboard & Mouse Shortcuts.md new file mode 100644 index 0000000..8512e09 --- /dev/null +++ b/tiddlers/content/reference/TipsAndTricks/_Reference_Tips & Tricks_Keyboard & Mouse Shortcuts.md @@ -0,0 +1,83 @@ +The following are some useful general purpose keyboard navigation and mouse/touchpad selection shortcuts that should work in most applications and that many people are not aware of. + +## Keyboard Navigation + +You don't have to keep reaching for the mouse/touchpad to move your cursor! + +Note that the following keys: <>,<>, <>, and <>, are referring to the arrow keys on your keyboard. + +Move by word: + ~ Windows / Linux: < 🠘 or 🠚">> + + Mac: < 🠘 or 🠚">> + + Hold down <> at the same time to select the word (or multiple consecutive words). + +Delete word to left of cursor: + ~ Windows / Linux: < Backspace">> + + Mac: < Delete">> + +Delete word to right of cursor: + ~ Windows / Linux: < Delete">> + + Mac: < Option > Delete">> + +Jump to start or end of the current line: + ~ Windows / Linux: <> or <> + + Mac: < 🠘 or 🠚">> + + Hold down <> to select from the current cursor position. + +Jump to top or bottom of current page/screen (varies by application): + ~ Windows / Linux: <> or <> + + Mac: < 🠙 or 🠛">> + + Hold down <> to select from the current cursor position. + +Jump to top or bottom of file/document: + ~ Windows / Linux: < Home">> or < End">> + + Mac: < 🠙 or 🠛">> + + Hold down <> to select from the current cursor position. + +Try to get into the habit of using keyboard shortcuts when editing text rather than reaching for the mouse/touchpad. You will be a lot more efficient that way. + +## Mouse/Touchpad Selection + +Select a word: + ~ Double click the word. + +Select consecutive words: + ~ Double click the first word and then drag while holding down the mouse button. + + This is more efficient than the standard 'click and drag' selection since it automatically selects entire words --- you don't need to be as precise with the mouse/trackpad. + + This should be your default selection technique since most of the time you will want to select entire words. + +Select a line/paragraph: + ~ Triple click the any where in the line/paragraph. + +Extend/shrink a selection: + ~ Hold down <> and drag. + + You can extend/shrink the selection by a single word by clicking the word while <> is held down. + + This technique is useful if you missed your intended end target. You don't need to start the selection again --- just extend/shrink it. + +## Mac Finder Shortcuts + +These are useful features that have no corresponding buttons or menus (or these features are hidden by default) so knowing the shortcut keys is very useful. + +Go to home folder: < Shift > H ">> + +Go to a specific path: < Shift > G ">> + +Go to parent folder: < 🠙">> + +Toggle hidden files/folders: < Shift > .">> + +Create new folder: < Shift > N">> diff --git a/tiddlers/content/reference/TipsAndTricks/_Reference_Tips & Tricks_Keyboard & Mouse Shortcuts.md.meta b/tiddlers/content/reference/TipsAndTricks/_Reference_Tips & Tricks_Keyboard & Mouse Shortcuts.md.meta new file mode 100644 index 0000000..2491bec --- /dev/null +++ b/tiddlers/content/reference/TipsAndTricks/_Reference_Tips & Tricks_Keyboard & Mouse Shortcuts.md.meta @@ -0,0 +1,3 @@ +tags: reference toc +title: /Reference/Tips & Tricks/Keyboard & Mouse Shortcuts +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Boxes.md b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Boxes.md new file mode 100644 index 0000000..c99ae12 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Boxes.md @@ -0,0 +1,39 @@ +There is a `box` style that can be used with a `
` to surround text in a box. + +``` +
This stuff is in a box
+``` + +Produces: + +
This stuff is in a box
+ +Can be combined with icons: + +``` +
<> Don't run with scissors.
+``` + +Produces: + +
<> Don't run with scissors.
+ +Combining HTML and Markdown can easily break the Markdown renderer --- you may need to resort to full HTML if you want to do anything fancy inside the box. + +For example: + +``` +
<> **Don't** run with scissors.
+``` + +Will produce the following **incorrect** output: + +
<> **Don't** run with scissors.
+ +Wheareas the following will work: + +``` +
<> Don't run with scissors.
+``` + +
<> Don't run with scissors.
\ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Boxes.md.meta b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Boxes.md.meta new file mode 100644 index 0000000..8177356 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Boxes.md.meta @@ -0,0 +1,3 @@ +tags: cheatsheet +title: $:/Cheatsheet/Cheatsheet/Boxes +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Code Highlighting.tid b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Code Highlighting.tid new file mode 100644 index 0000000..f104ec3 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Code Highlighting.tid @@ -0,0 +1,77 @@ +tags: cheatsheet +title: $:/Cheatsheet/Cheatsheet/Code Highlighting +type: text/vnd.tiddlywiki + +! Inline Code + +Inline code can be created using the back quote character to surround the code. This works in both Markdown and WikiText. + +Example: + +``` +Blah `blah` blah. +``` + +Produces: + +Blah `blah` blah. + +! Code Blocks + +Triple back quotes, and the language: +
```java
+public static void main(String...args) {
+  System.out.println("Hello, world.");
+}
+```
+ +Produces: + +```java +public static void main(String...args) { + System.out.println("Hello, world."); +} +``` + +For a list of supported languages: +https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md + +Note that for plain text (where you don't want syntax highlighting) you can use either: +
```
+plain text goes here
+```
+ +which produces: + +``` +plain text goes here +``` + +or + +
```plaintext
+plain text goes here
+```
+ +which produces: + +```plaintext +plain text goes here +``` + +The difference is that TiddlyWiki handles the first, and the `highlight.js` plugin handles the second. Depending on themes, they can produce output with different styles. We have tried to make the styles consistent, but there may be subtle differences. + +You can also use HTML `
` tags with Unicode literals if your content includes things that TiddlyWiki will try to interpret (such as triple-backquotes).  Trying to display Markdown source code is a good example of this.
+
+```plaintext
+
```
+code goes here
+```
+``` + +Produces: + +
```
+code goes here
+```
+ diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_HTML.md b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_HTML.md new file mode 100644 index 0000000..d373e40 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_HTML.md @@ -0,0 +1 @@ +You can use HTML in either WikiText or Markdown Tiddlers. The Markdown renderer can be a bit fragile, so you sometimes need to resort to HTML if it loses the plot. \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_HTML.md.meta b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_HTML.md.meta new file mode 100644 index 0000000..3bff223 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_HTML.md.meta @@ -0,0 +1,3 @@ +tags: cheatsheet +title: $:/Cheatsheet/Cheatsheet/HTML +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Handy Unicode Characters.md b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Handy Unicode Characters.md new file mode 100644 index 0000000..5cb0a04 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Handy Unicode Characters.md @@ -0,0 +1,41 @@ +Some Unicode characters that are occasionally handy: + +* ❭ : `❭` + + `U+0276D` MEDIUM RIGHT-POINTING ANGLE BRACKET ORNAMENT + + Handy as an ornamental separator. Used by `<>` macro. + +* ``` : ````` + + Triple back quotes. + + Use with `
` tags for formatting things like Markdown or WikiText source code.
+
+* ꤷ : `ꤷ`
+
+	`U+A937` REJANG LETTER BA
+
+	Useful for adding a forward slash to a Tiddler title.  **Might not be available in all fonts — it is best to avoid using slashes in titles altogether**.
+
+* `​`
+
+	`U+200B` ZERO WIDTH SPACE
+
+	Useful for preventing the Markdown auto-dingus from converting things like (​c) into ©.
+
+* @: `@`
+
+	`U+FF20` FULL WIDTH COMMERCIAL AT
+
+	Useful for email addresses that would otherwise be converted into hyperlinks which can cause problems with the very fragile Markdown parser.
+
+* ☺: `☺`
+
+	`U+263A` WHITE SMILING FACE
+
+* ☹: `☹`
+
+	`U+2639` WHITE FROWNING FACE
+
+See:  https://www.compart.com/en/unicode/block/U+FF00 for half/full width versions of common characters that might be useful when auto-markup features are getting in the way.
diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Handy Unicode Characters.md.meta b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Handy Unicode Characters.md.meta
new file mode 100644
index 0000000..12e0c1c
--- /dev/null
+++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Handy Unicode Characters.md.meta
@@ -0,0 +1,3 @@
+tags: cheatsheet
+title: $:/Cheatsheet/Cheatsheet/Handy Unicode Characters
+type: text/x-markdown
\ No newline at end of file
diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Hidden Tiddlers.md b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Hidden Tiddlers.md
new file mode 100644
index 0000000..1c3bfaa
--- /dev/null
+++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Hidden Tiddlers.md
@@ -0,0 +1 @@
+Tiddlers with titles that start with `$:/` are hidden. They are also excluded from the search.
\ No newline at end of file
diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Hidden Tiddlers.md.meta b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Hidden Tiddlers.md.meta
new file mode 100644
index 0000000..abd08bb
--- /dev/null
+++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Hidden Tiddlers.md.meta
@@ -0,0 +1,3 @@
+tags: cheatsheet
+title: $:/Cheatsheet/Cheatsheet/Hidden Tiddlers
+type: text/x-markdown
\ No newline at end of file
diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Icons.tid b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Icons.tid
new file mode 100644
index 0000000..01ca1fe
--- /dev/null
+++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Icons.tid
@@ -0,0 +1,43 @@
+tags: cheatsheet
+title: $:/Cheatsheet/Cheatsheet/Icons
+type: text/vnd.tiddlywiki
+
+The following macros can be used to include icon characters:
+
+```plaintext
+<> Don't run with scissors.
+```
+Produces:
+
+<> Don't run with scissors.
+
+
+ +```plaintext +<> Pay attention! +``` +Produces: + +<> Pay attention! + +
+ + +```plaintext +<> +``` +Produces: + +<> + +The path is a Tiddler that contains an image. The image will be automatically scaled, so can be any size. + +The icons can be embedded in a paragraph: + +``` +Click the <> icon to disconnect from the database. +``` + +Produces: + +Click the <> icon to download the internet. \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_Images.tid b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_Images.tid new file mode 100644 index 0000000..035c5da --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_Images.tid @@ -0,0 +1,29 @@ +tags: cheatsheet +title: $:/Cheatsheet/Cheatsheet/Images/Images +type: text/vnd.tiddlywiki + +Transclude another tiddler that has SVG/PNG/JPG as its contents: + +You use double curly brackets to transclude, with the title of the image in the brackets: + +``` +{{$:/Cheatsheet/Cheatsheet/svg_example}} +``` +Produces: +{{$:/Cheatsheet/Cheatsheet/svg_example}} + +Look at $:/Cheatsheet/Cheatsheet/svg_example for an example of how to create an SVG tiddler. You need to set the type to `image/svg+xml` (or whatever type that the image content is). + +!! SVG + +You can control the size using a `
` with a `width` style: + +``` +
{{$:/Cheatsheet/Cheatsheet/svg_example}}
+``` +Produces: + +
{{$:/Cheatsheet/Cheatsheet/svg_example}}
+ +Using `
` will make the image fit nicely on a printed page. + diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_Optimising.tid b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_Optimising.tid new file mode 100644 index 0000000..d1ba25d --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_Optimising.tid @@ -0,0 +1,39 @@ +tags: cheatsheet +title: $:/Cheatsheet/Cheatsheet/Images/Optimising +type: text/vnd.tiddlywiki + +Since everything is embedded directly inside the HTML file, you should try to keep any images as small as possible (in terms of file size) to prevent the HTML file from becoming too large. + +!! SVG + +`svgcleaner` seems to be the best tool for reliably shrinkifying SVG files (does a better job of using groups to apply shared styles than `scour`): + +https://github.com/RazrFalcon/svgcleaner + +Available in Arch as `community/svgcleaner`. + +Run using: + +```plaintext +svgcleaner file.svg file_opt.svg +``` + +If you want the output in a human readable form rather than one massive line: + +```plaintext +svgcleaner --indent=1 file.svg file_opt.svg +``` + +!! PNG + +`oxipng` seems to be the best of the commonly available PNG optimisers. It has support for Zopfli which generally offers better compression than zlib. + +https://github.com/shssoichiro/oxipng + +Available in Arch as `community/oxipng`. + +Run using: + +```plaintext +oxipng --strip safe --alpha --zopfli -o max --out file_opt.png file.png +``` \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_PNG and JPEG.md b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_PNG and JPEG.md new file mode 100644 index 0000000..353a8c2 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_PNG and JPEG.md @@ -0,0 +1 @@ +You can create a new Tiddler, and drag and drop the PNG or JPEG from your file manager into the Tiddler. \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_PNG and JPEG.md.meta b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_PNG and JPEG.md.meta new file mode 100644 index 0000000..b52e064 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_PNG and JPEG.md.meta @@ -0,0 +1,3 @@ +tags: cheatsheet +title: $:/Cheatsheet/Cheatsheet/Images/PNG and JPEG +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_SVG.md b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_SVG.md new file mode 100644 index 0000000..04d51a7 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_SVG.md @@ -0,0 +1,52 @@ +SVG can be copy/pasted straight into a Tiddler. You can then set the type to `image/svg+xml`. + +## Controlling Size + +If you remove the root level `width` and `height` attributes from the SVG, but leave the `viewBox` then it becomes dynamically resizable, and will automatically fill its container. + +You can then control the size using a `
` with a `width` style: + +``` +
{{$:/Cheatsheet/Cheatsheet/svg_example}}
+``` + +Produces: + +
{{$:/Cheatsheet/Cheatsheet/svg_example}}
+ +## Printing + +Using a `width` of `185mm` makes it fit nicely on a printed A4 portrait page. + +## Dark Theme + +Some students do use the dark theme. Having an image with a white background can be a bit dazzling when everything else is dark. + +There are two solution: + +* Don't set a background color at all. The image will use the page background which will be inherited from the theme. + +* If you do have black text that needs to be displayed over the background then you need to set the background to something that will have some contrast so that the text is visible. Setting the alpha channel to %50 opaque with a white background is a pretty good compromise --- black text is still clearly visible, but the contrast different will not be dazzling. + +Compare the following (flip the dark/light themes). + +White background: + + + +No background: + + + +Semi-opaque 50% white background: + + + + +The following is the SVG code for the semi-opaque versions: + +``` + +``` + +Note the `style` attribute. \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_SVG.md.meta b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_SVG.md.meta new file mode 100644 index 0000000..af0d772 --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_SVG.md.meta @@ -0,0 +1,3 @@ +tags: cheatsheet +title: $:/Cheatsheet/Cheatsheet/Images/SVG +type: text/x-markdown \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_svg_example.svg b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_svg_example.svg new file mode 100644 index 0000000..085e4ff --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_svg_example.svg @@ -0,0 +1 @@ + diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_svg_example.svg.meta b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_svg_example.svg.meta new file mode 100644 index 0000000..6f8274b --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Images_svg_example.svg.meta @@ -0,0 +1,2 @@ +title: $:/Cheatsheet/Cheatsheet/Images/svg_example +type: image/svg+xml \ No newline at end of file diff --git a/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Markdown_Comments.md b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Markdown_Comments.md new file mode 100644 index 0000000..6d1d7fa --- /dev/null +++ b/tiddlers/system/cheatsheet/$__Cheatsheet_Cheatsheet_Markdown_Comments.md @@ -0,0 +1,9 @@ +Markdown doesn't have a comment. There are eleventy bazillion different ways of simulating a comment by abusing things to effectively hide a chunk of text, but they are all very sensitive to which Markdown renderer you are using. The safest bet is a `
` with a style that sets `display` to `none`. The <