Twine-based reimagination of the Vaughan Memorial Library's award-winning original You Quote It, You Note It! Adobe Flash plagiarism tutorial.
Please refer to LICENSE.md.
information-literacy@acadiau.ca
Acadia University: Vaughan Memorial Library 50 Acadia Street, Wolfville, Nova Scotia, Canada, B4P 2R6
https://library.acadiau.ca/research/citation-help.html
Important: This project uses Twee and SCSS source files and must be compiled using Twee2. It is not compatible with Twine's standard GUI editor.
Requirements:
- Twee2 which itself requires Ruby (version 2.0 or newer) and Gems package manager.
- SugarCube 2 version 2.33.2 or newer.
Build the project via script:
- From the command line, run
/build(Linux) orbuild.bat(Windows) found in the project folder to automatically compile the twee and SCSS source files.
Or if you prefer to build the project manually:
- Create an empty
/builddirectory in the project root. - Copy
/README.mdto/build - Copy
/LICENSE.mdto/build - Copy the entire
/assetsdirectory to/build/assets. - From the project root directory, run
twee2 build story.tw ./build/story.html
Google Analytics (optional):
- Open
/build/story.htmlin a plain-text editor. - Insert your Google Site Tag snippet in the
<head>block between the<meta name="viewport" ...>tag and SugarCube preamble comments block. - If You Quote It, You Note It! renders improperly or displays error messages when viewed in a browser after inserting Google Analytics code, you can assume that either there is a syntax error—double-check placement of the Google Site Tag snippet—or that your text editor improperly saved
story.html(in which case, you must start over and rebuild the project from scratch).
Once built, copy the contents of the /build directory to your web host. You may rename story.html to <something_else>.html if so desired.
Changes can be made to the project's Twee and SCSS files using your favorite text editor. If you do so, please be sure to change the value of Twee2::build_config.story_ifid in twee2_configuration.tw before rebuilding the project in order to distinguish your variant from the official application.
twee2_configuration.tw: Twee2-specific configuration settings, plus global SugarCube2 overrides.story.tw: Story initialization, includes, and select application-level passages.storyinclude_<LANG>_<X>.tw: Included story passages broken up into logical components.storyinclude_<LANG>_common.tw: Content passages that are common to the entire tutorial, regardless of citation style.storyinclude_<LANG>_style_<apa|asa|chicago|mla>.tw: Content passages specific to an individual citation style—APA, ASA, Chicago and MLA.storyinclude_<LANG>_license.tw: License information passage.storyinclude_start.tw: Title ("Start") passage.storyinclude_headerfooter.tw: Global header and footer portions of the user interface.storyinclude_macros.tw: Assorted macro functions used throughout the application.storyinclude_debug.tw: Debugging passages, macros and CSS. Used only when$debug = 1instory.tw.
css_story.scss: SCSS-syntax stylesheet for the entire application.assets/: Supplementary assets including audio, emoji and images. (Note: No images are included with the project by default.)dowatchanddowatch.bat: Project watch scripts—allows one to make changes and recompile automatically for real-time application testing in a web browser. (Requires Google Chrome to be installed on your computer.)dobuildanddobuild.bat: Project build scripts.include_google_analytics.html: Google Site Tag snippet for optional Google Analytics addition post-build. Don't forget to replace theUA-...ID value with that from your own Analytics account.sugarcube2/SugarCube2.33.2/: SugarCube2 story format version 2.33.2 provided for convenience.
Tutorial content is provided in English and French with storyinclude_... files denoted by "en" and "fr" abbreviations, respectively.
To translate You Quote It, You Note It! into another language, copy each of the English storyinclude files (storyinclude_en_<X>.tw) to new files named with your preferred language abbreviation and replace the contents therein. For example, German and Spanish translations should be named storyinclude_de_<X>.tw and storyinclude_es_<X>.tw, respectively. Passage identifiers within the Twee source code must also use these same language abbreviations.
Edit story.tw by appending the names of your newly translated storyinclude files to the list identified by ::StoryIncludes. Next, open storyinclude_start.tw for editing and add a new link element to the ::Start passage for the new translation. To remove a language choice, delete or comment-out (HTML style comment tags) its corresponding link element. The "Start" passage acts as the tutorial's title page and these link elements provide the way for one to choose their preferred language.
If English should not be the default language, open story.tw again, locate the $lang variable in ::StoryInit and change its value to the desired language abbreviation.
Finally, don't forget to rebuild the project after you've made changes to the language settings.
- Freesound: sound clip repository; items licensed under Creative Commons
- Google Fonts
- OpenDyslexic: font face
- Twemoji: Twitter's open source emoji set