Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>I mostly write academic papers with LaTeX. However, my research has to do with software documentation, so I actually deal with some of these concerns.</p> <p>The best thing about LaTeX is that you are concerned with content and structure, not just visual layout. This is like writing HTML with CSS rather than pure HTML.</p> <p>Here are a few reasons that I think LaTeX is useful for creating some documentation:</p> <p>One reason is that dealing with multiple styles is more structured and styles are more "logical" than "visual". For example, if you are typing in Word, every time you want to mention a class or object, you change a style. In LateX, as I type, I write something like:</p> <blockquote> <p>bla bla bla~\methodName{foo} bla bla~\className{FooBar}.</p> </blockquote> <p>I find that for long documents, this is useful. I can easily find my class names, change them, etc.</p> <p>A second benefit is that I can use macros for entities. For example, suppose that I have some module that handles some functionality, but that its name may change later or that I'm not sure what it is. I can have a macro called \ModuleForXXX, and when I eventually pick a name or change it. </p> <p>A third and perhaps most important benefit is that it is easier to create a document from a hierarchy of files in LaTeX than in a Word document. I typically have a main file that then includes other files, that then include other files and so on. I view it hierarchically (at least on Windows with WinEDT), and I can easily rearrange the order of things just by changing inclusions. Needless to say, I also use includes for the actual content of code excerpts and documentation text.</p> <p>LaTeX has several drawbacks though: 1) Few people know it and some people who are used to Word just resent it. However, for someone who reads a final PDF, it shouldn't matter. 2) Image placement can be a little tricky, though you can override options and force LaTeX to listen to your instructions. 3) It works best with a dual monitor configuration.</p>
    singulars
    1. This table or related slice is empty.
    1. POCan LaTeX be used for producing any documentation that accompanies software?
      singulars
      1. PTQuestion
    1. PTAnswer
    1. This table or related slice is empty.
    1. USUri
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. POCan LaTeX be used for producing any documentation that accompanies software?
      singulars
      1. PTQuestion
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. COI didn't know that stuff. Thanks for the information.
      singulars
      1. PO
      1. USmmr
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload