Dokumentformat där man kan dölja sektioner dynamiskt?

[Troberg]

Grundproblem: I många fall har man en massa text som inte behövs för en specifik läsare. I vår värld, så kanske man har hela regelsektioner som inte behövs för en specifik värld. I tex bilmanualer/servicemanualer så finns instruktioner för varenda jävla variant av bilen som någonsin lämnat fabriken, inte bara för det specifika fordonet. Projektdokumentation där alla nivåer är blandade, från övergripande planering ner till kodutformning.

Så, min tanke är något i stil med:

Man skriver ett dokument där man taggar sektioner. Säg, "magi", "cybernetik", "superkrafter" osv.

Sedan kan man mata dokumentläsaren med en lista på sektioner som ska visas/döljas. Så, tex till en fantasyvärld, så kan man lista "cybernetik", "superkrafter", "eldvapen", "rymdstrid" osv som dolda. Det ger då läsaren ett kompakt dokument där enbart det som används visas.

Det känns som ett rätt så vanligt förekommande behov, och egentligen en rätt så trivial sak att göra (as such things goes).

Finns det?

Som vanligt, helst open source, helst gratis, Linux eller Windows.

 

[wilper]

Preprocessorn för C?

 

[Rymdhamster]

Excel.

 

[Troberg]

Preprocessorn för C?

Typ, men mer dokumentbaserat.

Tycker det borde finnas massor av situationer där man behöver förvalta flera olika varianter av ett dokument med minimal informationsduplicering.

 

[wilper]

Jag hade gjort det i LaTeX.

Aubrey Anderson

Men då är ju LaTeX redan mitt standardverktyg för text. Det kanske är lite mycket att lära sig bara för den funktionen.

 

[Übereil]

Jag föreslår Markdown. Tror förvisso inte det går att "mata" en markdownläsare med vad som ska vara kollapsat från början men det går att kollapsa rubriker vilket borde vara bra nog för ändamålet. Tycker man inte det duger så borde man kunna skapa ett script som genererar markdown där man kan filtrera vad som ska och inte ska vara med utan några större problem.

Übereil

 

[Troberg]

Nja, kollapsade rubriker är väl bra, men då krävs att det kan styras utifrån.

Jag har börjat fundera på en annan lösning, baserat på Wilpers kommentar om preprocessor. Min tanke då är att man har en massa textsnuttar, som man sedan sätter ihop i ett dokument som i princip bara är en lista med "include textsnuttsnamn". Man skulle tex kunna ha HTMLsnuttar som man sätter ihop. Ett sådant program slänger man ihop på en timme eller två. Enda haken är att jag inte gillar HTML.

 

[Mekanurg]

Det är i och för sig många år sedan jag jobbade med Framemaker, men om jag minns rätt, kunde man generera PDFer där man valde att utelämna dokumentbitar som inte behövdes.

 

[Rickard]

Känns som om man ska skriva sektionerna som enskilda filer och sedan ha ett program som genererar en pdf utifrån de filer som väljs.

"Enda" svårigheten är sidnumrering och innehållsförteckning för "pdf merge"-program finns redan. Kanske möjligtvis även referenser (pdf-länkar).

 

[ingefära]

r markdown verkar ge vissa programmerings- och parameteriseringsmöjligheter. det kanske stödjer ditt use-case.

 

[Tant Ragnar]

Grundproblem: I många fall har man en massa text som inte behövs för en specifik läsare. I vår värld, så kanske man har hela regelsektioner som inte behövs för en specifik värld. I tex bilmanualer/servicemanualer så finns instruktioner för varenda jävla variant av bilen som någonsin lämnat fabriken, inte bara för det specifika fordonet. Projektdokumentation där alla nivåer är blandade, från övergripande planering ner till kodutformning.

Så, min tanke är något i stil med:

Man skriver ett dokument där man taggar sektioner. Säg, "magi", "cybernetik", "superkrafter" osv.

Sedan kan man mata dokumentläsaren med en lista på sektioner som ska visas/döljas. Så, tex till en fantasyvärld, så kan man lista "cybernetik", "superkrafter", "eldvapen", "rymdstrid" osv som dolda. Det ger då läsaren ett kompakt dokument där enbart det som används visas.

Det känns som ett rätt så vanligt förekommande behov, och egentligen en rätt så trivial sak att göra (as such things goes).

Finns det?

Som vanligt, helst open source, helst gratis, Linux eller Windows.

Nu var det ett tag sedan, men jag stod inför exakt samma problem på jobbet för ett par år sedan.

Vid det tillfället tyckte jag att AsciiDoc var lösningen.

 

[Übereil]

Jag har börjat fundera på en annan lösning, baserat på Wilpers kommentar om preprocessor. Min tanke då är att man har en massa textsnuttar, som man sedan sätter ihop i ett dokument som i princip bara är en lista med "include textsnuttsnamn". Man skulle tex kunna ha HTMLsnuttar som man sätter ihop. Ett sådant program slänger man ihop på en timme eller två. Enda haken är att jag inte gillar HTML.

Om jag ska vara sån så låter det där rätt likt vad jag föreslog som alternativ om kollapsade rubriker inte var bra nog... Men just Markdown är lätt att generera, eftersom att det är rent textbaserat.

Största problemet är att jag inte tror vanliga mugglare har markdown-läsare. Jag brukar använda VS Code om det inte är en fil jag bara vill läsa som är incheckad i jobbets kod-repo i Azure DevOps. En snabbgoogling indikerar att det går att konvertera till PDF, men jag vet inte hur lätt det är.

Übereil

 

[wilper]

Och från markdown kan man ju generera andra format som ser hjälpligt bra ut, om det skulle önskas.

 

[Troberg]

Om jag ska vara sån så låter det där rätt likt vad jag föreslog som alternativ om kollapsade rubriker inte var bra nog... Men just Markdown är lätt att generera, eftersom att det är rent textbaserat.

Största problemet är att jag inte tror vanliga mugglare har markdown-läsare. Jag brukar använda VS Code om det inte är en fil jag bara vill läsa som är incheckad i jobbets kod-repo i Azure DevOps. En snabbgoogling indikerar att det går att konvertera till PDF, men jag vet inte hur lätt det är.

Übereil

Jag kan tänka mig att göra en lite markdown->html-kompilator, med stöd för denna typ av includes.