Add guides

Author: coatless

docs/_quarto.yml

@@ -15,6 +15,12 @@ website:
     contents: 
       - text: "Home"
         file: index.qmd
+      - section: "Examples"
+        contents:
+        - text: "Toggle for All Cells"
+          href: qtoggle-all-cells.qmd
+        - text: "Toggle Specific Cells"
+          href: qtoggle-specific-cells.qmd
       - section: "Support"
         contents:
         - text: "FAQ"

docs/qtoggle-all-cells-example.qmd

@@ -0,0 +1,114 @@
+---
+title: "Toggle for All Cells"
+format: 
+  html:
+    toc: true
+toggle:
+    output-toggle: true    # Enable toggle buttons for all cells
+    output-hidden: false   # Show outputs initially (default)
+filters:
+  - toggle
+---
+
+This page demonstrates how to globally enable toggle functionality
+for all code cells, rather than enabling it on a per cell configuration.
+This approach allows you to skip individual cell configurations unless
+you want to override the global behavior.
+
+## Setup
+
+To enable toggle for all cells, add this to your document's YAML header:
+
+```yaml
+---
+title: "Your Document Title"
+format: html
+toggle:
+  output-toggle: true    # Automatically add toggle to all cells
+  output-hidden: false   # Show outputs by default
+filters: [toggle]
+---
+```
+
+With this set, every code cell that produces an output gets a toggle button 
+automatically and outputs are visible by default. Readers can hide them if 
+they choose.
+
+This means: 
+
+- No need to add `toggle: true` to individual cells as it will apply to all.
+- Outputs are visible by default (readers can hide them)
+- Consistent experience across your entire document
+
+Hover over code blocks to see toggle buttons. `"⌄"` = visible, `"›"` = hidden.
+
+## Python Examples
+
+### Output
+
+```{python}
+print("Hello, world!")
+print("This has a toggle button.")
+```
+
+### Math Operations
+
+```{python}
+numbers = [1, 2, 3, 4, 5]
+print(f"Sum: {sum(numbers)}")
+print(f"Average: {sum(numbers)/len(numbers)}")
+```
+
+### Plotting with Matplotlib
+
+```{python}
+import matplotlib.pyplot as plt
+plt.plot([1, 2, 3], [1, 4, 9], 'o-')
+plt.title("Simple Plot")
+plt.show()
+```
+
+## R Examples
+
+### Statistics Calculations
+
+```{r}
+data <- c(10, 20, 30, 40, 50)   
+cat("Mean:", mean(data), "\n")
+cat("Max:", max(data), "\n")
+```
+
+### Graphing with Base R
+
+```{r}
+barplot(c(23, 45, 32), names.arg = c("A", "B", "C"))
+```
+
+## Override Options
+
+### Always Show
+
+No toggle button will be added, output is always visible.
+
+```{python}
+#| toggle: false
+print("Always visible - no toggle button")
+```
+
+### Hidden by Default
+
+Starts hidden - click toggle to show
+
+```{python}
+#| output-hidden: true
+print("You've clicked the toggle button to show me!")
+```
+
+## Other Languages
+
+### Bash
+
+```{bash}
+echo "Current date:"
+date
+```

docs/qtoggle-specific-cells-example.qmd

@@ -0,0 +1,126 @@
+---
+title: "Toggle Specific Cells"
+format: 
+  html:
+    toc: true
+    code-fold: true
+    code-summary: "Show code"
+filters:
+  - toggle
+---
+
+This page demonstrates how to selectively enable toggle functionality
+for specific code cells, rather than enabling it document-wide. This 
+approach gives you precise control over which cells have toggle buttons.
+
+## Setup
+
+To enable selective toggle, use this minimal setup:
+
+```yaml
+---
+title: "Your Document Title"
+format: html
+filters: [toggle]
+---
+```
+
+The `filters: [toggle]` enables the toggle extension for the document
+so that only cells with `toggle: true` get toggle buttons.
+
+## Examples
+
+### Important Results (No Toggle)
+
+```{python}
+total = 1500
+target = 1200
+print(f"Sales: ${total} (Target: ${target})")
+```
+
+### Details (With Toggle)
+
+```{python}
+#| toggle: true
+breakdown = [400, 500, 600]
+for i, amount in enumerate(breakdown, 1):
+    print(f"Q{i}: ${amount}")
+```
+
+### Debug Info (Hidden by Default)
+
+```{python}
+#| toggle: true
+#| output-hidden: true
+print("Processing time: 2.3s")
+print("Memory: 45MB")
+```
+
+## R Examples
+
+### Key Results (No Toggle)
+
+```{r}
+scores <- c(85, 90, 78, 92)
+cat("Average:", mean(scores), "\n")
+```
+
+### Analysis (With Toggle)
+
+```{r}
+#| toggle: true
+scores <- c(85, 90, 78, 92)
+cat("Min:", min(scores), "Max:", max(scores), "\n")
+```
+
+### Visualization (With Toggle)
+
+```{r}
+#| toggle: true
+hist(c(85, 90, 78, 92), main = "Scores")
+```
+
+## Mixed Strategy
+
+### Summary (Always Visible)
+
+```{python}
+risk = "Medium"
+confidence = 89
+print(f"Risk: {risk} ({confidence}% confidence)")
+```
+
+### Supporting Data (Toggle)
+
+```{python}
+#| toggle: true
+factors = {"Market": 3.2, "Credit": 2.8}
+for name, score in factors.items():
+    print(f"{name}: {score}")
+```
+
+### Technical Notes (Hidden)
+
+```{python}
+#| toggle: true
+#| output-hidden: true
+print("Model v2.1.3")
+print("Updated: 2024-05-28")
+```
+
+## With Code Folding
+
+This page uses `code-fold: true` so you can control code and output independently.
+
+### Function Example
+
+```{python}
+#| toggle: true
+def growth_rate(current, previous):
+    return (current - previous) / previous * 100
+
+result = growth_rate(1500, 1200)
+print(f"Growth: {result:.1f}%")
+```
+
+Use `toggle: true` for optional details. Keep key results without toggles.