|
| 1 | +# Course Page Style Guide for BS Physics |
| 2 | + |
| 3 | +This guide ensures consistency across all course pages in the `_bs_physics` directory. |
| 4 | + |
| 5 | +## Standard Collapsible Section Structure |
| 6 | + |
| 7 | +**ALL course pages MUST include these 6 sections in this exact order:** |
| 8 | + |
| 9 | +1. **Textbooks & References** - `<i class="fas fa-book"></i>` |
| 10 | +2. **Homework & Assignments** - `<i class="fas fa-file-alt"></i>` |
| 11 | +3. **Exams & Solutions** - `<i class="fas fa-chart-bar"></i>` |
| 12 | +4. **Quizzes & Solutions** - `<i class="fas fa-check-circle"></i>` |
| 13 | +5. **Lecture Notes** - `<i class="fas fa-book-open"></i>` |
| 14 | +6. **Computational Materials** - `<i class="fas fa-laptop-code"></i>` |
| 15 | + |
| 16 | +### Additional Specialized Sections (Optional) |
| 17 | + |
| 18 | +Add these AFTER the 6 standard sections when applicable: |
| 19 | + |
| 20 | +- **Lab Materials** - `<i class="fas fa-flask"></i>` (for laboratory courses) |
| 21 | +- **Projects** - `<i class="fas fa-clipboard-list"></i>` (for project-based courses) |
| 22 | +- **Seminar Materials** - `<i class="fas fa-chart-bar"></i>` (for seminar courses like PHYS 499) |
| 23 | +- **Research Materials** - `<i class="fas fa-clipboard-list"></i>` (for research courses like PHYS 497) |
| 24 | + |
| 25 | +## Section Template |
| 26 | + |
| 27 | +### Basic Structure |
| 28 | +```markdown |
| 29 | +<details> |
| 30 | +<summary><strong><i class="fas fa-[ICON]"></i> [Section Title]</strong></summary> |
| 31 | +<ul> |
| 32 | +<li><a href="/assets/resources/[path]/[file].pdf">[Description]</a></li> |
| 33 | +</ul> |
| 34 | +</details> |
| 35 | +``` |
| 36 | + |
| 37 | +### First Section (Always Open) |
| 38 | +The first section (Textbooks & References) should always be open by default: |
| 39 | +```markdown |
| 40 | +<details open> |
| 41 | +<summary><strong><i class="fas fa-book"></i> Textbooks & References</strong></summary> |
| 42 | +``` |
| 43 | + |
| 44 | +### Empty Sections |
| 45 | +If a section has no content yet, use this placeholder: |
| 46 | +```markdown |
| 47 | +<details> |
| 48 | +<summary><strong><i class="fas fa-[ICON]"></i> [Section Title]</strong></summary> |
| 49 | +<ul> |
| 50 | +<li>No materials available yet</li> |
| 51 | +</ul> |
| 52 | +</details> |
| 53 | +``` |
| 54 | + |
| 55 | +## Complete Course Page Template |
| 56 | + |
| 57 | +```markdown |
| 58 | +--- |
| 59 | +layout: course |
| 60 | +code: PHYS XXX |
| 61 | +title: [Course Title] |
| 62 | +slug: physXXX |
| 63 | +credits: X-X-X |
| 64 | +level: XXX |
| 65 | +description: [Course description] |
| 66 | +prerequisites: [Prerequisites] |
| 67 | +semester_offered: F/S/F,S |
| 68 | +course_type: Core/Elective |
| 69 | +--- |
| 70 | + |
| 71 | +[Course description paragraph] |
| 72 | + |
| 73 | +**Prerequisites:** [Prerequisites] |
| 74 | + |
| 75 | +## <i class="fas fa-book"></i> Course Resources |
| 76 | + |
| 77 | +<details open> |
| 78 | +<summary><strong><i class="fas fa-book"></i> Textbooks & References</strong></summary> |
| 79 | +<ul> |
| 80 | +<li><a href="/assets/resources/core/physXXX/textbooks/[file].pdf">[Book Title - Author]</a></li> |
| 81 | +</ul> |
| 82 | +</details> |
| 83 | + |
| 84 | +<details> |
| 85 | +<summary><strong><i class="fas fa-file-alt"></i> Homework & Assignments</strong></summary> |
| 86 | +<ul> |
| 87 | +<li><a href="/assets/resources/core/physXXX/homework/[file].pdf">Homework 1</a></li> |
| 88 | +</ul> |
| 89 | +</details> |
| 90 | + |
| 91 | +<details> |
| 92 | +<summary><strong><i class="fas fa-chart-bar"></i> Exams & Solutions</strong></summary> |
| 93 | +<ul> |
| 94 | +<li><a href="/assets/resources/core/physXXX/exams/[file].pdf">Major Exam I - Solution</a></li> |
| 95 | +</ul> |
| 96 | +</details> |
| 97 | + |
| 98 | +<details> |
| 99 | +<summary><strong><i class="fas fa-check-circle"></i> Quizzes & Solutions</strong></summary> |
| 100 | +<ul> |
| 101 | +<li><a href="/assets/resources/core/physXXX/quizzes/[file].pdf">Quiz 1 - Solution</a></li> |
| 102 | +</ul> |
| 103 | +</details> |
| 104 | + |
| 105 | +<details> |
| 106 | +<summary><strong><i class="fas fa-book-open"></i> Lecture Notes</strong></summary> |
| 107 | +<ul> |
| 108 | +<li><a href="/assets/resources/core/physXXX/notes/[file].pdf">Chapter 1 - Notes</a></li> |
| 109 | +</ul> |
| 110 | +</details> |
| 111 | + |
| 112 | +<details> |
| 113 | +<summary><strong><i class="fas fa-laptop-code"></i> Computational Materials</strong></summary> |
| 114 | +<ul> |
| 115 | +<li><a href="/assets/resources/core/physXXX/computational/[file].nb">[Description] (Mathematica)</a></li> |
| 116 | +</ul> |
| 117 | +</details> |
| 118 | +``` |
| 119 | + |
| 120 | +## File Naming Conventions |
| 121 | + |
| 122 | +### Link Text Format |
| 123 | +- **Homework:** "Homework [Number]" or descriptive title |
| 124 | +- **Exams:** "Major Exam [Number] - Solution" or "Final Exam - Solution" |
| 125 | +- **Quizzes:** "Quiz [Number] - Solution" |
| 126 | +- **Lecture Notes:** "Chapter [Number] - [Topic]" or descriptive title |
| 127 | +- **Computational:** "[Description] (Software Name)" |
| 128 | + |
| 129 | +### Path Structure |
| 130 | +All resources should follow this path pattern: |
| 131 | +``` |
| 132 | +/assets/resources/[core|elective]/physXXX/[category]/[filename] |
| 133 | +``` |
| 134 | + |
| 135 | +Where `[category]` is one of: |
| 136 | +- `textbooks` |
| 137 | +- `homework` |
| 138 | +- `exams` |
| 139 | +- `quizzes` |
| 140 | +- `notes` |
| 141 | +- `computational` |
| 142 | +- `lab` (for lab materials) |
| 143 | +- `projects` |
| 144 | + |
| 145 | +## Important Rules |
| 146 | + |
| 147 | +### DO NOT: |
| 148 | +- Mix icons with different section titles |
| 149 | +- Use `fas fa-clipboard-list` for "Homework Assignments" (use `fas fa-file-alt` for "Homework & Assignments") |
| 150 | +- Use variations like "Homework & Solutions" or "Homework Assignments" |
| 151 | +- Combine "Quizzes & Exams" in one section (keep them separate) |
| 152 | +- Use `fas fa-book-open` for multiple different purposes |
| 153 | +- Change the order of the standard 6 sections |
| 154 | +- Omit any of the standard 6 sections (use placeholder if empty) |
| 155 | + |
| 156 | +### ALWAYS: |
| 157 | +- Include all 6 standard sections, even if empty |
| 158 | +- Use exact icon-title pairings as specified |
| 159 | +- Keep the first section (Textbooks & References) open by default |
| 160 | +- Place specialized sections AFTER the standard 6 |
| 161 | +- Use "No materials available yet" for empty sections |
| 162 | +- Maintain consistent link text formatting |
| 163 | + |
| 164 | +## Examples of Common Mistakes to Avoid |
| 165 | + |
| 166 | +❌ **Wrong:** |
| 167 | +```markdown |
| 168 | +<summary><strong><i class="fas fa-clipboard-list"></i> Homework Assignments</strong></summary> |
| 169 | +``` |
| 170 | + |
| 171 | +✅ **Correct:** |
| 172 | +```markdown |
| 173 | +<summary><strong><i class="fas fa-file-alt"></i> Homework & Assignments</strong></summary> |
| 174 | +``` |
| 175 | + |
| 176 | +❌ **Wrong:** |
| 177 | +```markdown |
| 178 | +<summary><strong><i class="fas fa-chart-bar"></i> Quizzes & Exams</strong></summary> |
| 179 | +``` |
| 180 | + |
| 181 | +✅ **Correct:** (Two separate sections) |
| 182 | +```markdown |
| 183 | +<summary><strong><i class="fas fa-chart-bar"></i> Exams & Solutions</strong></summary> |
| 184 | +... |
| 185 | +<summary><strong><i class="fas fa-check-circle"></i> Quizzes & Solutions</strong></summary> |
| 186 | +``` |
| 187 | + |
| 188 | +## Validation Checklist |
| 189 | + |
| 190 | +Before committing any course page, verify: |
| 191 | +- [ ] All 6 standard sections are present in the correct order |
| 192 | +- [ ] Icons match the section titles exactly as specified |
| 193 | +- [ ] First section has `<details open>` attribute |
| 194 | +- [ ] Empty sections have "No materials available yet" placeholder |
| 195 | +- [ ] No duplicate or redundant sections |
| 196 | +- [ ] Specialized sections appear after the standard 6 |
| 197 | +- [ ] File paths follow the `/assets/resources/[type]/physXXX/[category]/` pattern |
| 198 | + |
| 199 | +## Adding New Content |
| 200 | + |
| 201 | +When adding new materials to existing sections: |
| 202 | +1. Maintain alphabetical or numerical order within sections |
| 203 | +2. Use consistent naming patterns (e.g., all homework as "Homework 1", "Homework 2", etc.) |
| 204 | +3. Include file format in parentheses for computational materials (e.g., "(Mathematica)", "(Python)", "(PDF)") |
| 205 | +4. For solutions, always append " - Solution" to the title |
| 206 | + |
| 207 | +--- |
| 208 | + |
| 209 | +*Last Updated: January 2025* |
| 210 | +*This guide ensures consistency across all physics course pages. Any deviations require explicit justification and should be documented.* |
0 commit comments