Differences

This shows you the differences between two versions of the page.

Link to this comparison view

wiki:syntax [on August 3, 2026] (current)
psychdb [Callouts]
Line 1: Line 1:
 +====== PsychDB Manual of Style (MoS) and Syntax ======
 +===== Primer =====
 +The **PsychDB Manual of Style (MoS)** is the style manual for all PsychDB articles. This MoS details PsychDB'​s house style, to help editors write articles with consistent and precise language, layout, and formatting, making PsychDB easier and more intuitive for users.
 +===== Article Formatting =====
 +All PsychDB articles follow a structured following format:
 +
 +<WRAP group>
 +<WRAP half column>
 +**Code**
 +<​code>​
 +====== Article Title (h1) ======
 +**Article Title (Abbreviation)** is bolded with a one sentence introduction.
 +===== Primer (h2) =====
 +==== Subheading (h3) ====
 +===== Resources (h2) =====
 +</​code>​
 +</​WRAP>​
 +
 +<WRAP half column>
 +**Rendered Code**
 +<WRAP center round box 100%>
 +====== Article Title (h1) ======
 +**Article Title (Abbreviation)** is bolded with a one sentence introduction.
 +===== Primer (h2) =====
 +==== Subheading (h3) ====
 +===== Resources (h2) =====
 +</​WRAP>​
 +</​WRAP>​
 +</​WRAP>​
 +
 +
 +
 +===== Diagnostic Criteria Formatting =====
 +Most diagnostic criteria in articles are based on DSM-5 criteria. Some formatting guidelines:
 +  * All diagnostic values or thresholds (i.e. - numbers) are placed in quotations to highlight them in blue, (e.g. - ''​1''​)
 +  * All Criterion (e.g. - Criterion A, B, C, etc...) are formatted as "​h5"​
 +<WRAP group>
 +<WRAP half column>
 +**Code**
 +<​code>​
 +===== Diagnostic Criteria (h1) =====
 +== Criterion A (h5) == 
 +At least **''​5''​** out of 9 symptoms present in the same **''​2-week''​** period and represent a change from previous functioning. At least **''​1''​** of the 5 symptoms is either (1) depressed mood or (2) loss of interest or pleasure (anhedonia).
 +</​code>​
 +</​WRAP>​
 +
 +<WRAP half column>
 +**Rendered Code**
 +<WRAP center round box 100%>
 +===== Diagnostic Criteria (h1) =====
 +== Criterion A (h5) == 
 +At least **''​5''​** out of 9 symptoms present in the same **''​2-week''​** period and represent a change from previous functioning. At least **''​1''​** of the 5 symptoms is either (1) depressed mood or (2) loss of interest or pleasure (anhedonia).
 +</​WRAP>​
 +</​WRAP>​
 +</​WRAP>​
 +
 +
 +
 +
 +
 +
 +
 +===== Specifiers Formatting =====
 +The DSM-5 requires diagnoses to be coded in the following order: [diagnosis][episode specifier][severity/​psychotic/​remission][with specifiers]
 +
 +**Accordion**
 +  * If there is just one specifier panel, the //​accordion//​ tag should be removed, this will allow the first panel to be seen directly without clicking on it
 +  * If there is more than one specifier panel, the //​accordion//​ tag should be kept, with a value of //​collapse="​false"//,​ this will allow the first panel to be seen directly without clicking on it
 +
 +<WRAP group>
 +<WRAP half column>
 +**Code**
 +<​code>​
 +<WRAP group>
 +<WRAP half column>
 +<panel icon="​fa fa-search-plus fa-fw" size="​xs"​ title="​Episode Specifier">​
 +  * Episode
 +</​panel>​
 +<panel icon="​fa fa-signal fa-fw" size="​xs"​ title="​Severity Specifier">​
 +  * **Mild**: Lorem
 +  * **Moderate**:​ Ipsum
 +  * **Severe**: Dolor
 +</​panel>​
 +<panel icon="​fa fa-hourglass fa-fw" size="​xs"​ title="​Remission Specifier">​
 +  * **In partial remission**:​ Dolor
 +  * **In full remission**:​ Sit
 +</​panel>​
 +</​WRAP>​
 +<WRAP half column>
 +<​accordion collapse="​false">​
 +<panel icon="​fa fa-plus-circle fa-fw" size="​xs"​ title="​With anxious distress">​
 +  * Criterion A
 +    * Criterion A1
 +  * **Severity**:​
 +    * **Mild**: ''​2''​ symptoms
 +    *  **Moderate**:​ ''​3''​ symptoms
 +    * **Moderate-severe**:​ ''​4''​ or ''​5''​ symptoms
 +    * **Severe**: ''​4''​ or ''​5''​ symptoms and with motor agitation
 +<​callout>​
 +**Note**: Callout information.</​callout>​
 +</​panel>​
 +<panel icon="​fa fa-plus-circle fa-fw" size="​xs"​ title="​With mixed features">​
 +The mixed features specifier can apply to the current manic, hypomanic, or depressive episode in bipolar I or bipolar II disorder:
 +
 +**Specifier Criteria**:
 +  * **A**. Criterion A
 +    * (1) Criterion A1
 +</​panel>​
 +</​accordion>​
 +
 +<panel icon="​fa fa-plus-circle fa-fw" size="​xs"​ title="​Specifiers with No Additional Text">​
 +  * **Lorem**
 +  * **Ipsum**
 +</​panel>​
 +</​WRAP>​
 +</​WRAP>​
 +</​code>​
 +</​WRAP>​
 +
 +<WRAP half column>
 +**Rendered Code**
 +<WRAP center round box 100%>
 +<WRAP group>
 +<WRAP half column>
 +<panel icon="​fa fa-search-plus fa-fw" size="​xs"​ title="​Episode Specifier">​
 +  * Episode
 +</​panel>​
 +<panel icon="​fa fa-signal fa-fw" size="​xs"​ title="​Severity Specifier">​
 +  * **Mild**: Lorem
 +  * **Moderate**:​ Ipsum
 +  * **Severe**: Dolor
 +</​panel>​
 +<panel icon="​fa fa-hourglass fa-fw" size="​xs"​ title="​Remission Specifier">​
 +  * **In partial remission**:​ Dolor
 +  * **In full remission**:​ Sit
 +</​panel>​
 +</​WRAP>​
 +
 +<WRAP half column>
 +<​accordion collapse="​false">​
 +<panel icon="​fa fa-plus-circle fa-fw" size="​xs"​ title="​With anxious distress">​
 +  * Criterion A
 +    * Criterion A1
 +  * **Severity**:​
 +    * **Mild**: ''​2''​ symptoms
 +    *  **Moderate**:​ ''​3''​ symptoms
 +    * **Moderate-severe**:​ ''​4''​ or ''​5''​ symptoms
 +    * **Severe**: ''​4''​ or ''​5''​ symptoms and with motor agitation
 +<​callout>​
 +**Note**: Callout information.</​callout>​
 +</​panel>​
 +<panel icon="​fa fa-plus-circle fa-fw" size="​xs"​ title="​With mixed features">​
 +The mixed features specifier can apply to the current manic, hypomanic, or depressive episode in bipolar I or bipolar II disorder:
 +
 +**Specifier Criteria**:
 +  * **A**. Criterion A
 +    * (1) Criterion A1
 +</​panel>​
 +</​accordion>​
 +
 +<panel icon="​fa fa-plus-circle fa-fw" size="​xs"​ title="​Specifiers with No Additional Text">​
 +  * **Lorem**
 +  * **Ipsum**
 +</​panel>​
 +</​WRAP>​
 +</​WRAP>​
 +</​WRAP>​
 +</​WRAP>​
 +</​WRAP>​
 +
 +===== Callouts =====
 +Callouts draw attention to key points in an article and come in different colours and styles. Take a look at the actual PsychDB articles for examples on how best to use these different callouts.
 +<callout icon="​true"​ title="​Default">​ [...] </​callout>​
 +<callout type="​primary"​ icon="​true"​ title="​Primary">​ Use this as a general purpose call out </​callout>​
 +<callout type="​question"​ icon="​true"​ title="​Question?">​ Use this for an FAQ Type Callout with the Question as the title, and the answer sitting within the callout tags</​callout>​
 +<callout type="​success"​ icon="​true"​ title="​Success">​ [...] </​callout>​
 +<callout type="​info"​ icon="​true"​ title="​Info">​ [...] </​callout>​
 +<callout type="​warning"​ icon="​true"​ title="​Warning">​ [...] </​callout>​
 +<callout type="​tip"​ icon="​true"​ title="​Tip">​ [...] </​callout>​
 +<callout type="​danger"​ icon="​true"​ title="​Danger">​ [...] </​callout>​
 +
 +===== Buttons =====
 +<btn type="​default">​Default</​btn>​
 +<btn type="​success">​Success</​btn>​
 +<btn type="​danger">​Danger</​btn>​
 +
 +<btn type="​primary">​Primary</​btn>​
 +<btn type="​info">​Info</​btn>​
 +<btn type="​warning">​Warning</​btn>​
 +<btn type="​link">​Link</​btn>​
 +
 +<btn type="​success"​ size="​lg"​ icon="​glyphicon glyphicon-edit">​Hello</​btn>​
 +
 +<btn type="​primary"​ size="​lg">​Large button</​btn>​
 +<btn type="​default"​ size="​lg">​Large button</​btn>​
 + 
 +<btn type="​primary">​Default button</​btn>​
 +<btn type="​default">​Default button</​btn>​
 + 
 +<btn type="​primary"​ size="​sm">​Small button</​btn>​
 +<btn type="​default"​ size="​sm">​Small button</​btn>​
 + 
 +<btn type="​primary"​ size="​xs">​Extra small button</​btn>​
 +<btn type="​default"​ size="​xs">​Extra small button</​btn>​
 +
 +<btn type="​primary"​ size="​lg"​ block="​true">​Block level button</​btn>​
 +<btn type="​default"​ size="​lg"​ block="​true">​Block level button</​btn>​
 +===== Mnemonics =====
 +
 +<WRAP group>
 +<WRAP half column>
 +**Code**
 +<​code>​
 +<callout icon="​fa fa-lightbulb-o"​ type="​success"​ title="​Mnemonic">​
 +The mnemonic ''​**M SIGECAPS**''​ can be used to remember the criteria for major depressive disorder.
 +<​HTML><​br><​br></​HTML>​
 +  * ''​**M**''​ Mood
 +  * ''​**S**''​ Sleep
 +  * ''​**I**''​ Interest
 +  * ''​**G**''​ Guilt/​Worthlessness
 +  * ''​**E**''​ Energy
 +  * ''​**C**''​ Concentration
 +  * ''​**A**''​ Appetite
 +  * ''​**P**''​ Psychomotor Slowing
 +  * ''​**S**''​ Suicide
 +</​callout>​
 +</​code>​
 +</​WRAP>​
 +
 +<WRAP half column>
 +**Rendered Code
 +**<WRAP center round box 100%>
 +<callout icon="​fa fa-lightbulb-o"​ type="​success"​ title="​Mnemonic">​
 +The mnemonic ''​**M SIGECAPS**''​ can be used to remember the criteria for major depressive disorder.
 +<​HTML><​br><​br></​HTML>​
 +  * ''​M''​ Mood
 +  * ''​S''​ Sleep
 +  * ''​I''​ Interest
 +  * ''​G''​ Guilt/​Worthlessness
 +  * ''​E''​ Energy
 +  * ''​C''​ Concentration
 +  * ''​A''​ Appetite
 +  * ''​P''​ Psychomotor Slowing
 +  * ''​S''​ Suicide
 +</​callout></​WRAP>​
 +
 +</​WRAP>​
 +</​WRAP>​
 +
 +===== Differential Diagnosis =====
 +
 + <​WRAP group>
 +<WRAP half column>
 +**Code**
 +<​code>​
 +===== Differential Diagnosis =====
 +== Subheading (Optional) ==
 +  * **Diagnosis (do not capitalize after first word)**
 +    * Lorem ipsum
 +  * **[[child:​adhd|Attention-deficit/​hyperactivity disorder]]**
 +    * Lorem ipsum
 +</​code>​
 +</​WRAP>​
 +
 +<WRAP half column>
 +**Rendered Code
 +**<WRAP center round box 100%>
 +===== Differential Diagnosis =====
 +== Subheading (Optional) ==
 +  * **Diagnosis (do not capitalize after first word)**
 +    * Lorem ipsum
 +  * **[[child:​adhd|Attention-deficit/​hyperactivity disorder]]**
 +    * Lorem ipsum
 +</​WRAP>​
 +</​WRAP>​