documentatie in realtime op pagina ‘ s toevoegen en bekijken. Alternatieve namen voor deze module zouden “contextuele documentatie” of “Realtime documentatie” kunnen zijn, maar inline heeft een mooie ring en komt overeen met de manier waarop documentatie in code wordt geplaatst.
deze module maakt een inhoudstype “Inline Documentation” aan en voegt een ronde blauwe knop toe aan de rechterbenedenhoek van elke pagina. Deze knop schakelt een paneel met een lijst van de inline documentatieknooppunten aan / uit.
documentatie is de sleutel voor eenvoudig onderhoud of projectoverdracht. Echter, niemand houdt ervan om documentatie te schrijven en niemand houdt ervan om documentatie te lezen.
Inline documentatie probeert het schrijven van documentatie te vergemakkelijken door de gebruiker toe te staan korte stukjes documentatie rechtstreeks toe te voegen aan de webpagina waar de lezer het nodig heeft. Dit vermindert de behoefte aan uitgebreide Wiki-pagina ‘ s en Word-documenten.
Navigeer naar de pagina in kwestie, klik op de knop ‘documentatie toevoegen’ en begin met het schrijven van enkele documenten. Het wordt aanbevolen om deze documenten kort en eenvoudig te houden, u kunt er zoveel aan een pagina toevoegen als u wilt en u kunt ze zelfs aan DOM-elementen koppelen.