Skip to content

Commit 829dd36

Browse files
committed
docs: minor updates
1 parent c34a87a commit 829dd36

3 files changed

Lines changed: 27 additions & 27 deletions

File tree

docs/coding/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ instructions, debriefing, etc...). We call the phases "Views" and each major
5151
phase of an experiment is associated with its own Vue component. Learn about
5252
views [here](/coding/views).
5353

54-
<img src="/images/viewstimeline.png" width="800" alt="timeline example" style="margin: auto;">
54+
<img src="/images/viewstimeline.png" width="600" alt="timeline example" style="margin: auto;">
5555

5656
Smile comes with several [built-in views](/coding/views#built-in-views) for
5757
common phases of an experiment. This includes things like obtaining informed

docs/coding/views.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ capital 'V' to distinguish them from ordinary uses of the word "view."). Other
1212
packages might refer to View elements as "pages", "routes", "sections", "parts",
1313
or "phases."
1414

15-
<img src="/images/viewstimeline.png" width="800" alt="timeline example" style="margin: auto;">
15+
<img src="/images/viewstimeline.png" width="600" alt="timeline example" style="margin: auto;">
1616

1717
To help make clear the distinction between a View and an ordinary component,
1818
consider the following examples:
@@ -248,12 +248,12 @@ Example `design.js` entry:
248248

249249
```js
250250
// put this at the top of the file
251-
import Advertisement from '@/builtins/advertisement/AdvertisementView.vue'
251+
import AdvertisementView from '@/builtins/advertisement/AdvertisementView.vue'
252252

253253
timeline.pushSeqView({
254254
path: '/welcome',
255255
name: 'welcome_anonymous',
256-
component: Advertisement,
256+
component: AdvertisementView,
257257
meta: {
258258
prev: undefined,
259259
next: 'consent',
@@ -268,12 +268,12 @@ Prolific:
268268

269269
```js
270270
// put this at the top of the file
271-
import Advertisement from '@/builtins/advertisement/AdvertisementView.vue'
271+
import AdvertisementView from '@/builtins/advertisement/AdvertisementView.vue'
272272

273273
timeline.pushSeqView({
274274
path: '/welcome/:service',
275275
name: 'welcome_referred',
276-
component: Advertisement,
276+
component: AdvertisementView,
277277
meta: {
278278
prev: undefined,
279279
next: 'consent',
@@ -318,12 +318,12 @@ experiment in a new browser window.
318318

319319
```js
320320
// put this at the top of the file
321-
import MTurk from '@/builtins/mturk/MTurkRecruitView.vue'
321+
import MTurkRecruitView from '@/builtins/mturk/MTurkRecruitView.vue'
322322

323323
this.registerView({
324324
path: '/mturk',
325325
name: 'mturk',
326-
component: MTurk,
326+
component: MTurkRecruitView,
327327
props: {
328328
estimated_time: api.getConfig('estimated_time'),
329329
payrate: api.getConfig('payrate'),
@@ -361,12 +361,12 @@ consent (also `@/builtins/informedConsent/InformedConsentText.vue`).
361361

362362
```js
363363
// put this at the top of the file
364-
import Consent from '@/builtins/informedConsent/InformedConsentView.vue'
364+
import InformedConsentView from '@/builtins/informedConsent/InformedConsentView.vue'
365365

366366
// consent
367367
timeline.pushSeqView({
368368
name: 'consent',
369-
component: Consent,
369+
component: InformedConsentView,
370370
meta: {
371371
requiresConsent: false,
372372
setConsented: true, // set the status to consented ater this route
@@ -404,13 +404,13 @@ To add it to the timeline just add this in the appropriate place inside
404404

405405
```js
406406
// put this at the top of the file
407-
import WindowSizer from '@/builtins/windowSizer/WindowSizerView.vue'
407+
import WindowSizerView from '@/builtins/windowSizer/WindowSizerView.vue'
408408

409409
// windowsizer
410410
timeline.pushSeqView({
411411
path: '/windowsizer',
412412
name: 'windowsizer',
413-
component: WindowSizer,
413+
component: WindowSizerView,
414414
})
415415
```
416416

@@ -432,7 +432,7 @@ accessibility**: `{requiresConsent: true, requiresDone: false}`
432432

433433
```js
434434
// put this at the top of the file
435-
import Instructions from '@/builtins/instructions/InstructionsView.vue'
435+
import InstructionsView from '@/builtins/instructions/InstructionsView.vue'
436436
import useAPI from '@/core/composables/useAPI'
437437
const api = useAPI()
438438

@@ -445,7 +445,7 @@ api.randomAssignCondition({
445445
// instructions
446446
timeline.pushSeqView({
447447
name: 'instructions',
448-
component: Instructions,
448+
component: InstructionsView,
449449
meta: {
450450
allowAlways: true,
451451
},
@@ -554,12 +554,12 @@ relies on color information.
554554

555555
```js
556556
// put this at the top of the file
557-
import DemographicSurvey from '@/builtins/demographicSurvey/DemographicSurveyView.vue'
557+
import DemographicSurveyView from '@/builtins/demographicSurvey/DemographicSurveyView.vue'
558558

559559
timeline.pushSeqView({
560560
path: '/demograph',
561561
name: 'demograph',
562-
component: DemographicSurvey,
562+
component: DemographicSurveyView,
563563
})
564564
```
565565

@@ -595,12 +595,12 @@ field.
595595

596596
```js
597597
// put this at the top of the file
598-
import DeviceSurvey from '@/builtins/deviceSurvey/DeviceSurveyView.vue'
598+
import DeviceSurveyView from '@/builtins/deviceSurvey/DeviceSurveyView.vue'
599599

600600
timeline.pushSeqView({
601601
path: '/demograph',
602602
name: 'demograph',
603-
component: DeviceSurvey,
603+
component: DeviceSurveyView,
604604
meta: { setDone: true }, // optional if this is the last form
605605
})
606606
```
@@ -632,7 +632,7 @@ compensation.
632632

633633
```js
634634
// put this at the top of the file
635-
import Withdraw from '@/builtins/withdraw/WithdrawView.vue'
635+
import WithdrawView from '@/builtins/withdraw/WithdrawView.vue'
636636

637637
// withdraw
638638
timeline.registerView({
@@ -641,7 +641,7 @@ timeline.registerView({
641641
requiresWithdraw: true,
642642
resetApp: api.getConfig('allowRepeats'),
643643
},
644-
component: Withdraw,
644+
component: WithdrawView,
645645
})
646646
```
647647

@@ -660,13 +660,13 @@ their post-experiment surveys.
660660

661661
```js
662662
// put this at the top of the file
663-
import Debrief from '@/builtins/debrief/DebriefView.vue'
663+
import DebriefView from '@/builtins/debrief/DebriefView.vue'
664664

665665
// debrief
666666
import DebriefText from '@/user/components/DebriefText.vue' // get access to the global store
667667
timeline.pushSeqView({
668668
name: 'debrief',
669-
component: Debrief,
669+
component: DebriefView,
670670
props: {
671671
debriefText: markRaw(DebriefText),
672672
},
@@ -682,12 +682,12 @@ accessibility**: `{requiresDone: true}`
682682

683683
```js
684684
// put this at the top of the file
685-
import Thanks from '@/builtins/thanks/ThanksView.vue'
685+
import ThanksView from '@/builtins/thanks/ThanksView.vue'
686686

687687
// thanks
688688
timeline.pushSeqView({
689689
name: 'thanks',
690-
component: Thanks,
690+
component: ThanksView,
691691
meta: {
692692
requiresDone: true,
693693
resetApp: api.getConfig('allowRepeats'),
@@ -712,12 +712,12 @@ meta field.
712712

713713
```js
714714
// put this at the top of the file
715-
import TaskFeedbackSurvey from '@/builtins/taskFeedbackSurvey/TaskFeedbackSurveyView.vue'
715+
import TaskFeedbackSurveyView from '@/builtins/taskFeedbackSurvey/TaskFeedbackSurveyView.vue'
716716

717717
// feedback
718718
timeline.pushSeqView({
719719
name: 'feedback',
720-
component: TaskFeedbackSurvey,
720+
component: TaskFeedbackSurveyView,
721721
meta: { setDone: true }, // optional if this is the last form
722722
})
723723
```

docs/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ an experiment. For example, the part of your experiment that collects informed
1111
consent might be one View. Another View might be the debriefing form. Below we
1212
will describe how you define the sequence of Views in your experiment.
1313

14-
<img src="/images/viewstimeline.png" width="800" alt="timeline example" style="margin: auto;">
14+
<img src="/images/viewstimeline.png" width="600" alt="timeline example" style="margin: auto;">
1515

1616
Each View is minimally a Vue component (a special type of web development file)
1717
which can be written in whatever way you please. However, Smile provides a

0 commit comments

Comments
 (0)