{"action":"created","issue":{"url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/issues/49","repository_url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template","labels_url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/issues/49/labels{/name}","comments_url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/issues/49/comments","events_url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/issues/49/events","html_url":"https://github.com/evanbergeron/DND-5e-LaTeX-Template/issues/49","id":258243652,"number":49,"title":"New User Manual document","user":{"login":"BrianCriswell","id":22409403,"avatar_url":"https://avatars0.githubusercontent.com/u/22409403?v=4","gravatar_id":"","url":"https://api.github.com/users/BrianCriswell","html_url":"https://github.com/BrianCriswell","followers_url":"https://api.github.com/users/BrianCriswell/followers","following_url":"https://api.github.com/users/BrianCriswell/following{/other_user}","gists_url":"https://api.github.com/users/BrianCriswell/gists{/gist_id}","starred_url":"https://api.github.com/users/BrianCriswell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/BrianCriswell/subscriptions","organizations_url":"https://api.github.com/users/BrianCriswell/orgs","repos_url":"https://api.github.com/users/BrianCriswell/repos","events_url":"https://api.github.com/users/BrianCriswell/events{/privacy}","received_events_url":"https://api.github.com/users/BrianCriswell/received_events","type":"User","site_admin":false},"labels":[{"id":186013787,"url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/labels/help%20wanted","name":"help wanted","color":"159818","default":true},{"id":186013789,"url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/labels/question","name":"question","color":"cc317c","default":true}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":7,"created_at":"2017-09-16T16:51:20Z","updated_at":"2017-10-09T06:35:21Z","closed_at":null,"author_association":"COLLABORATOR","body":"The example.pdf currently generated by the package looks beautiful, but I wonder if it helps new users grasp how to use the package. What does everyone think about changing it so that it looks more like the user manual found with fancyhdr <http://mirrors.ctan.org/macros/latex/contrib/fancyhdr/fancyhdr.pdf> or titlesec <http://mirrors.ctan.org/macros/latex/contrib/titlesec/titlesec.pdf>?\r\n\r\nThis would allow new users to see up front how to use the various parts of the package along with their options, and the current example could be included as an example at the end. What does everyone think?"},"comment":{"url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/issues/comments/335075314","html_url":"https://github.com/evanbergeron/DND-5e-LaTeX-Template/issues/49#issuecomment-335075314","issue_url":"https://api.github.com/repos/evanbergeron/DND-5e-LaTeX-Template/issues/49","id":335075314,"user":{"login":"benwebber","id":358027,"avatar_url":"https://avatars1.githubusercontent.com/u/358027?v=4","gravatar_id":"","url":"https://api.github.com/users/benwebber","html_url":"https://github.com/benwebber","followers_url":"https://api.github.com/users/benwebber/followers","following_url":"https://api.github.com/users/benwebber/following{/other_user}","gists_url":"https://api.github.com/users/benwebber/gists{/gist_id}","starred_url":"https://api.github.com/users/benwebber/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/benwebber/subscriptions","organizations_url":"https://api.github.com/users/benwebber/orgs","repos_url":"https://api.github.com/users/benwebber/repos","events_url":"https://api.github.com/users/benwebber/events{/privacy}","received_events_url":"https://api.github.com/users/benwebber/received_events","type":"User","site_admin":false},"created_at":"2017-10-09T06:35:21Z","updated_at":"2017-10-09T06:35:21Z","author_association":"CONTRIBUTOR","body":"> How is the documentation file organized? What order does the contents of the files appear in?\r\n\r\nWe would have a master documentation file that includes documentation for each module.\r\n\r\n```latex\r\n\\documentclass{ltxdoc}\r\n\r\n\\begin{document}\r\n  \\DocInput{dnd.sty}\r\n  \\DocInput{lib/dndcolors.sty}\r\n  % ...\r\n\\end{document}\r\n```\r\n\r\nIt makes sense to input them in execution order so the documentation reads from top-to-bottom.\r\n\r\n> What does the actual documentation look like?\r\n\r\nHere's an example: http://ftp.yzu.edu.tw/CTAN/macros/latex/contrib/oberdiek/hypdoc.pdf\r\n\r\nBasically, you have more developer-friendly documentation at the top, and implementation details at the end.\r\n\r\n> The trade-off for these kinds of systems is often balancing the plus that the code is part of your documentation vs the minus of less flexibility and ability to present the documentation in the manner desired. Where does this fit on that spectrum?\r\n\r\nYou can customize the ltxdoc output. For example, babel's documentation uses ltxdoc too. It's still a LaTeX document, just embedded in comments in the source files.\r\n\r\n> Does this work out of the box, or does it require additional software? Does it get in the way of someone downloading the module and wanting to compile example.tex to see what it looks like?\r\n\r\nWorks out of the box. It wouldn't touch the example document at all.\r\n\r\n---\r\n\r\nI'll produce a POC that documents one or two modules."}}
{"actor":{"display_login":"benwebber"}}