Welcome to the PhysicsLibrary documentation center. These guides collect practical notes for writing, editing, formatting, classifying, and maintaining PhysicsLibrary content.
Most documentation pages are collaborative objects. They can be improved by PhysicsLibrary users and then published here as site documentation.
Key Documents
- PhysicsLibrary New User Guide
- Getting started with encyclopedia contributions, alternate entries, metadata, LaTeX previews, file uploads, and references.
- Aaron Krowne's PlanetMath / Noosphere thesis
- Historical background on the original collaborative system that PhysicsLibrary descends from. The current site has changed substantially, but the thesis is still useful context for the design philosophy.
Recommended Guide Topics
These are good candidates for collaborative site documentation entries:
-
PhysicsLibrary Style Guide - voice, article structure, definitions, examples, references, and common editing conventions.
-
Adding Images and Figures - recommended LaTeX image patterns, captions, file uploads, and renderer-friendly sizing.
-
Tables and Formatting - examples for bordered tables, aligned equations, lists, theorem text, and references.
-
PACS Classification Guide - how to choose PACS categories and when broad classifications are appropriate.
-
Renderer Compatibility Notes - what works best across HTML with images, page images, PDF, TeX source, and make4ht.
Image Template
For PNG and JPG figures, prefer explicit width instead of bare image includes:
\begin{center}
\includegraphics[width=0.85\textwidth,keepaspectratio]{your-image.png}
{\small Figure 1. Short plain-text caption.}
\end{center}
Avoid TeX math in captions when possible. Plain-text captions behave better in older renderers.
Video Template
Currently only youtube embedded video links are allowed on PhysicsLibrary. You use the manual link contol sequence of \PMyoutube{https://youtu.be/VIDEO_ID}{A short description of the video.} A typical example:
\PMyoutube{https://youtu.be/6oGjAlrHjtE}{Companion video for the inertia-tensor similarity-transformation derivation.}Site Documentation Entries
- PlanetPhysics.org Style Guidelines
- A style guideline written by Aaron Krowne for PlanetMaths that is also useful for PlanetPhysics.
Last edit: 2010-10-07 04:29 by bci1
- Figure Guide for PhysicsLibrary
- This document is to help users make figures for PhysicsLibrary. Tools, tips and guidelines to get high quality figures into your physics articles.
Last edit: Sep 13 18:10 by bloftin
- Manual Linking Controls and LaTeX Examples
Last edit: Sep 1 04:04 by bloftin
- Physics Library Author Conventions
- An author guide to help with consistency and new folks to Physics Library as a good starting point.
Last edit: Sep 8 05:04 by bloftin
- Computational Resources Author Guide
- This guide is the place to go to learn how computational resources like Julia can be utilized on PhysicsLibrary.
Last edit: Sep 13 19:40 by bloftin
To propose a new documentation page, create a new collaboration, publish it, and ask an administrator to mark it as site documentation.
