https://touying-typ.github.io/assets/js/ddfb8371.db97b53f.js

1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2427],{61992:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var i=n(85893),s=n(11151);const o={sidebar_position:33,description:"Speaker notes are a way to add additional information to your slides that is not visible to the audience.",toc_max_heading_level:2},r="speaker-note",a={id:"reference/core/speaker-note",title:"speaker-note",description:"Speaker notes are a way to add additional information to your slides that is not visible to the audience.",source:"@site/docs/reference/core/speaker-note.mdx",sourceDirName:"reference/core",slug:"/reference/core/speaker-note",permalink:"/docs/reference/core/speaker-note",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:33,frontMatter:{sidebar_position:33,description:"Speaker notes are a way to add additional information to your slides that is not visible to the audience.",toc_max_heading_level:2},sidebar:"tutorialSidebar",previous:{title:"item-by-item-fn",permalink:"/docs/reference/core/item-by-item-fn"},next:{title:"alert",permalink:"/docs/reference/core/alert"}},d={},c=[{value:"mode : <TypeLink></TypeLink> <Default><code>&quot;typ&quot;</code></Default>",id:"mode",level:3},{value:"setting : <TypeLink></TypeLink> <Default><code>it =&gt; it</code></Default>",id:"setting",level:3},{value:"subslide : <TypeLink></TypeLink> | <TypeLink></TypeLink> | <TypeLink></TypeLink> | <TypeLink></TypeLink> | <TypeLink></TypeLink> <Default><code>auto</code></Default>",id:"subslide",level:3},{value:"note : <TypeLink></TypeLink>",id:"note",level:3}];function l(e){const t={a:"a",code:"code",h1:"h1",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components},{Default:n,Param:o,Parameters:r,Signature:a,SignatureName:d,SignatureParam:c,SourceLink:l,TypeLink:p}=t;return n||u("Default",!0),o||u("Param",!0),r||u("Parameters",!0),a||u("Signature",!0),d||u("SignatureName",!0),c||u("SignatureParam",!0),l||u("SourceLink",!0),p||u("TypeLink",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"speaker-note",children:"speaker-note"}),"\n",(0,i.jsx)(a,{children:(0,i.jsxs)("code",{children:[(0,i.jsx)(d,{children:"speaker-note"}),"(",(0,i.jsxs)(c,{children:[(0,i.jsx)(t.a,{href:"#mode",children:'mode: "typ"'}),", "]}),(0,i.jsxs)(c,{children:[(0,i.jsx)(t.a,{href:"#setting",children:"setting: it => it"}),", "]}),(0,i.jsxs)(c,{children:[(0,i.jsx)(t.a,{href:"#subslide",children:"subslide: auto"}),", "]}),(0,i.jsx)(c,{children:(0,i.jsx)(t.a,{href:"#note",children:"note"})}),")",(0,i.jsx)(l,{href:"https://github.com/touying-typ/touying/blob/main/src/core.typ#L2518"})]})}),"\n",(0,i.jsx)(t.p,{children:"Speaker notes are a way to add additional information to your slides that is not visible to the audience. This can be useful for providing additional context or reminders to yourself."}),"\n",(0,i.jsx)(t.p,{children:"Multiple calls on the same slide are combined (accumulated), so all notes are shown together."}),"\n",(0,i.jsx)(t.p,{children:"Example:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typ",children:"#speaker-note[This is a speaker note]\n"})}),"\n",(0,i.jsxs)(r,{children:[(0,i.jsxs)(t.h3,{id:"mode",children:["mode : ",(0,i.jsx)(p,{type:"str"})," ",(0,i.jsx)(n,{children:(0,i.jsx)(t.code,{children:'"typ"'})})]}),(0,i.jsx)(o,{children:(0,i.jsxs)(t.p,{children:["The mode of the markup text, either ",(0,i.jsx)(t.code,{children:"typ"})," or ",(0,i.jsx)(t.code,{children:"md"}),". Default is ",(0,i.jsx)(t.code,{children:"typ"}),"."]})}),(0,i.jsxs)(t.h3,{id:"setting",children:["setting : ",(0,i.jsx)(p,{type:"function"})," ",(0,i.jsx)(n,{children:(0,i.jsx)(t.code,{children:"it => it"})})]}),(0,i.jsx)(o,{children:(0,i.jsx)(t.p,{children:"A function that takes the note as input and returns a processed note."})}),(0,i.jsxs)(t.h3,{id:"subslide",children:["subslide : ",(0,i.jsx)(p,{type:"none"})," | ",(0,i.jsx)(p,{type:"auto"})," | ",(0,i.jsx)(p,{type:"int"})," | ",(0,i.jsx)(p,{type:"array"})," | ",(0,i.jsx)(p,{type:"str"})," ",(0,i.jsx)(n,{children:(0,i.jsx)(t.code,{children:"auto"})})]}),(0,i.jsx)(o,{children:(0,i.jsxs)(t.p,{children:["Restricts the note to specific subslides, similar to ",(0,i.jsx)(t.code,{children:"only"}),". - ",(0,i.jsx)(t.code,{children:"auto"})," (default): automatically determined from the current pause position. A note placed after ",(0,i.jsx)(t.code,{children:"#pause"})," will automatically appear only from that subslide onward. - ",(0,i.jsx)(t.code,{children:"none"}),": shown on all subslides regardless of position. - int, array, or string: shown only on the specified subslides."]})}),(0,i.jsxs)(t.h3,{id:"note",children:["note : ",(0,i.jsx)(p,{type:"content"})]}),(0,i.jsx)(o,{children:(0,i.jsxs)(t.p,{children:["The content of the speaker note. May contain ",(0,i.jsx)(t.code,{children:"#pause"})," to reveal parts progressively."]})})]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Returns:"})," ",(0,i.jsx)(p,{type:"content"})]})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},11151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>r});var i=n(67294);const s={},o=i.createContext(s);function r(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]);