Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Split into multiple files to avoid complicated merges #23

Open
vermiculus opened this issue Nov 1, 2016 · 11 comments
Open

Split into multiple files to avoid complicated merges #23

vermiculus opened this issue Nov 1, 2016 · 11 comments

Comments

@vermiculus
Copy link
Contributor

vermiculus commented Nov 1, 2016

We should consider splitting this document into multiple files to avoid complicated merges and allow for a clearer structure. I'd recommend a file structure like this:

/README.md                                ; actual summary of the project; annotated TOC
/guide/01-introduction-and-goals/README.md           ; introduction and goals
/guide/01-introduction-and-goals/image-for-ch1.png   ; some picture
/guide/02-your-first-document/REAMDE.md              ; first doc
...

Before I actually make the PR though, I'd like to nail down what the TOC should look like. This is what we have right now:

  • What is LaTeX?
  • Why use LaTeX?
  • Set up for LaTeX
  • First LaTeX file
  • A deeper look
  • Multilingual usage
  • Paragraph and section
  • Making a table of contents
  • Footnotes
  • What is a package?
  • Table
  • Adding images
  • Insert code into LaTeX
  • Additional Tools

Here's what I'd propose:

  • Preface and Installation

    Encompasses what/why, setup, and 'hello, world'. Gives a link to the section on multilingual support. Uses TeXworks as a 'click play' editor that's already installed with all major distributions.

  • Introduction

    Explains 'hello, world' example and introduces the concept of packages via another example. Introduces build tools like Arara that will be used in the rest of the document's examples (What should we do about compile steps? #22). Introduces other editors like Texmaker, TeXShop, Kile, Emacs, and Vim. Drives home the 'LaTeX is a markup language' point -- it's editor-agnostic.

  • Organizing Your Document

    Sectioning, tables of contents, and cross-referencing. Footnotes, images, tables, and LOFs/LOTs.

  • More sections as time goes on…

@luong-komorebi
Copy link
Owner

@vermiculus I understood what you are trying to do. Actually, I thought about spliting files into small bits while I was brainstorming for this repo. However, I also wanted it to be concise for people to get on LaTeX as fast as possible so I chose not to split it. On the "complicated merges" problem, I didn't see that coming 😢 . So now, I am a little confused whether to split or not. Can you leave me sometimes to consider?

@luong-komorebi
Copy link
Owner

@vermiculus I agreed with you now. Sadly, my computer just broke last night. Will you help me splitting things up if I add you to the repo as a collab?

@vermiculus
Copy link
Contributor Author

Can do.

@luong-komorebi
Copy link
Owner

@vermiculus Thank you. Invitation coming. Thank you.

If possible I would like to have a development branch so that we can discuss before pushing to the master branch 👍 .
Thank you, again. I will get back ASAP when my laptop is ready back.

@vermiculus
Copy link
Contributor Author

Why was this closed? Having open issues in a repository isn't a bad thing 😄

@luong-komorebi
Copy link
Owner

luong-komorebi commented Nov 19, 2016

@vermiculus No haha it's absolutely fine to me. haha 😄 I closed this because I thought we wouldn't accomplish this anyway. I myself didn't have the time to expand or split it. I don't know how about you haha but a long time have passed ( nearly 3 weeks ) so I closed it

@vermiculus
Copy link
Contributor Author

Sometimes many weeks go by until folks are able to get to issues 😄 most of this has to do with school / work schedule constraints. Issues trackers like GitHub's are made for just that: tracking would you'd like to do in a project. They're there so we don't forget 😉

@luong-komorebi
Copy link
Owner

luong-komorebi commented Dec 1, 2016

@vermiculus 😄 I totally understood now. Sorry for closing this issue weeks ago.

@aaossa
Copy link

aaossa commented Mar 26, 2017

So, will you split the README? I found this project a while ago and I was wondering if some translation work could be done too (I could translate it to Spanish, but it would take some time). I would like to help 😁

Maybe a new issue for translation and adding a label for "Begginer friendly" could bring more collaborators :)

(Just an idea, I like to find projects to collaborate 😁 )

@luong-komorebi
Copy link
Owner

@aaossa Thank you but I think I wouldn't split that. I would like to keep it simple, lean and straightforward. The guide is not that complex that it needs modularizing. In the future, I may think of upgrade it, then I would definitely split this readme file. But for now, just keep it simple like that.

Translation is welcomed, I never say I would ban that (lol 🤣 )

@bibbca
Copy link

bibbca commented Mar 20, 2018

Maybe we should start people off with an online LaTeX editor like Overleaf, ShareLaTeX, or Papeeria?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants