1
0
Fork 0
Commit Graph

62 Commits (9243eeb8bcc487ae375edb0910dcc592c99e3778)

Author SHA1 Message Date
Mike Gerwitz 514cad1575 doc: Source files and developer resources
* doc/hacking.texi: Added new sections to menu.
  (Source Files): New section.
  (Developer Resources): New section.
* doc/macros.texi (mocha,chai,easejs,gplv3): New macros for common links.
2018-05-04 10:57:56 -04:00
Mike Gerwitz f0a469944f doc: Macros for common library references
* doc/hacking.texi (Hacking): Use mocha, chai, easejs macros.
* doc/macros.texi (mocha, chai, easejs): New macros.
2018-05-04 10:39:46 -04:00
Mike Gerwitz 97873b618d doc: Add information on JS libraries used
* doc/hacking.texi: New file with information on libraries.
* doc/liza.texi: Include it.  Add to menu.
2018-05-04 10:39:46 -04:00
Mike Gerwitz c33adee21d client: Truncate diff posted to server after first null
Before this change, since `undefined' is encoded as `null' when serialized,
there was no way for the server to disambiguate between unmodified values
and a truncation point.  For example:

  [ undefined, undefined, null, null, null ]

The above array represents two unmodified and three removed indexes.  But
this is serialzed into JSON as:

  [ null, null, null, null, null ]

It isn't possible for the server to determine what the truncation point is
from that diff.  The solution is to therefore truncate the array _before_
sending it to the server, providing a trailing null to indicate that a
truncation has occurred:

  [ null, null, null ]

The above means that the first two indexes are unmodified, and that index 2
and later should all be truncated.

* doc/client.texi (Saving to Server): New section.
* src/client/transport/XhttpQuoteTransport.js (_truncateDiff): New method to
  perform truncation.
  (getBucketDataJson): Use it.
* test/client/transport/XhttpQuoteTransportTest.js: New file with respective
  test case.
2018-03-07 13:46:05 -05:00
Mike Gerwitz 8a01d5fd2e doc: Add @testrefjs macro
* doc/macros.texi (testrefjs): New macro for SRCURI and non-SRCURI.
2018-03-07 13:40:08 -05:00
Mike Gerwitz 0282be8903 .gitignore: Ignore *.t2p 2018-02-07 14:16:23 -05:00
Mike Gerwitz 6de77f02c0 doc: Begin documentation of DOM abstraction
* doc/program.texi (DOM Abstraction): New section.
2018-02-06 12:09:32 -05:00
Mike Gerwitz ffb709dbc4 doc: Add trivia macro
Useful for random historical facts that give useful context for developers
of Liza.  It hopefully helps to mitigate some of the issues of Theory
Building as noted by Peter Naur.

* doc/liza.css: Refactor some styles to make them more concise.
  (.trivia): Add styling.
* doc/macros.texi (trivia): Add macro.
2018-02-06 11:33:34 -05:00
Mike Gerwitz 1f6ea234ff StackedGroupUi: New group
* doc/program.texi (Group Styles): Add `stacked' to table.
* src/client/ClientDependencyFactory.js (createGroupUi): Recognize
  `stacked'.
* src/css/base.css (.stack-header): Style stack header.
* src/ui/group/StackedGroupUi.js: New group class.
2018-02-02 14:48:37 -05:00
Mike Gerwitz bd4887b2ad doc: Justify manual text
* doc/liza.css (body)[text-align]: Justify.
2018-02-02 14:08:01 -05:00
Mike Gerwitz 308b34b7ef doc: Group documentation
The primary motivation behind this change was documentation of
links.  Developers (including myself---it's been a while) misinterpreted
then as references to existing groups, not arbitrary names.

* doc/program.texi (Defining Groups): New section.
  (Group Styles): Reference to new section.
2018-02-02 09:44:14 -05:00
Mike Gerwitz bde44bb124 doc: {dev=>devnotice}, add devnotes
* doc/liza.css: Each of the entities below may have additional selectors
    following them, not listed here.
  (.doc-notice.dev): Renamed to `.devnotice'.
  (.doc-notice.devnotice, .doc-notice.devnote): New classes.
* doc/macros.texi (devnotice): {dev=>devnotice} @noticestart argument.
  (devnote): New macro.
2018-02-02 09:37:51 -05:00
Mike Gerwitz cdd87569c1 doc/pred.texi: UI predicates are existential
I'm not sure why I put universal here---they affect each index
individually.

* doc/pred.texi (Predicate System): {universal=>existentail}
2018-02-01 15:29:43 -05:00
Mike Gerwitz d9aa7ef4ab Basic documentation for bucket diff
* doc/bucket.texi (Bucket Diff): Add documentation.
2017-09-06 09:04:27 -04:00
Mike Gerwitz 5ddd2644f0 doc: Fix bin/server reference under Server
* doc/server.texi (Server): Fix bin/server reference, which was broken
    when SRCURI was set.
2017-08-31 11:04:41 -04:00
Mike Gerwitz 3fa464bc3a Extract bucket init code into ProgramInit
This represents a portion of the refactoring that I had intended to do
until I realized that there was a simpler solution to the problem that
we were having (having proguic add stored calculated values to the
defaults object).

So ideally we'll continue extracting all quote init code out of
`Server' and into `ProgramInit' in the future.

* doc/server.texi (Liza Server): Mention `ProgramInit'.
* src/program/ProgramInit.js: Add class.
* src/server/DocumentServer.js: Use it.
* src/server/Server.js (_progInit): Add private field.
  (__construct): Accept ProgramInit instance and assign to field.
  (initQuote): Use promise returned by `_getDefaultBucket'.
  (_getDefaultBucket): Proxy to `ProgramInit#init', which returns a
    promise.
2017-08-30 11:20:19 -04:00
Mike Gerwitz 5f8fb2fcc5 doc: Server invocation and configuration
* doc/server.texi (Liza Server): Add information on starting the
    server.
  (Server Configuration): Add subsection.
2017-08-29 14:56:13 -04:00
Mike Gerwitz 18cd46c87b doc/Makefile.am (liza_TEXINFOS): Add missing license.texi 2017-06-29 11:01:23 -04:00
Mike Gerwitz 0c24e3d280 Populate document metadata using Data APIs
What a cluster.

This was a lot of work to work around existing, bad APIs; there is no
time to refactor at the moment; this already took much longer than
expected.
2017-06-28 16:33:24 -04:00
Mike Gerwitz 07b5d2f1b6 doc: Began server documentation
* server.texi: Add file.
2017-06-22 13:07:30 -04:00
Mike Gerwitz c231983f34 doc: Add @jsmethod macro
* doc/macros.texi (@jsmethod): Add macro.
2017-06-21 13:20:56 -04:00
Mike Gerwitz f870ca964c doc: Add @todo
* doc/macros.texi (@todo): Add macro.
2017-06-21 13:20:40 -04:00
Mike Gerwitz 5c99243cdc doc: Add beginning of dapi documentation
* doc/Makefile.am (liza_TEXINFOS) [dapi.texi]: Include file.
* doc/dapi.texi: Add file.
* doc/design.texi: Add mention in list and reference chapter.
* doc/liza.texi: Reference chapter.
2017-06-21 10:52:46 -04:00
Mike Gerwitz be0121d8cb doc: Add @progxmlref, @dapi, @procguic{,x}ref, @proguicrefsuffix
* doc/macros.texi (@progxmlref, @dapi, @progcuicref, @proguicxref
  @proguicrefsuffix): Add macros.
2017-06-21 10:52:46 -04:00
Mike Gerwitz f873da0928 doc: Add @srcrefjs macros
* doc/macros.texi (srcrefjs): Add macros when src is both available and not
2017-06-21 10:52:46 -04:00
Mike Gerwitz 83b5f1ab74 doc: Update @helpwanted text
* doc/macros.texi (helpwanted): Adjust phrasing to account for some existing text.
2017-06-21 10:52:46 -04:00
Mike Gerwitz d2dd963614 doc: Extract design sections into own chapters
* assert.texi, bucket.texi, client.texi, pred.texi, program.texi,
  validation.texi: New files.
* design.texi: Extract text into above.
* liza.texi: Add @menu references and @include each new file.
2017-06-21 10:52:46 -04:00
Mike Gerwitz 6a86564364 Add missing FDL text
...!  No idea how this was missed.

* doc/license.texi: Add file.
* liza.texi: Use it.
2017-06-20 14:17:06 -04:00
Mike Gerwitz 55fccd8b8e Remove mvnotices from docs
Liza has been liberated.

* doc/design.texi: Remove all @mvnotice calls.
* doc/macros.texi (mvnotice): Remove macro.
2017-06-13 00:14:03 -04:00
Mike Gerwitz 1bb5191e3e LoVullo Associates => R-T Specialty
Copyright notices updated.  More casual references to "LoVullo
Associates" replaced with "RT Specialty / Lovullo", which will be "RT
Specialty Buffalo" in the future.  Or "RT Specialty", depending on how
this is rolled out.  Or "Ryan Specialty Group".  Who knows.

"R-T Specialty, LLC." is the legal name, which includes the dash.  Not
to be confused with a certain television network.
2017-06-08 14:48:43 -04:00
Mike Gerwitz 0cf800f5d9 Add event graph diagram
* doc/diagram/event-graph.dot: Add graph.
* doc/diagram/.gitignore: Ignore `*.svg'.
2017-06-08 14:38:32 -04:00
Mike Gerwitz 54d2eff8b9 Add diagram generation with graphviz
* configure.ac (TWOPI, HAS_TWOPI): Add variables.
  Check for towpi.
* doc/.gitignore (diagrams/*.svg): Add output file ignore.
* doc/Makefile.am: Add svg diagram building.
2017-06-08 14:38:32 -04:00
Mike Gerwitz 7c6b884895 doc/design.texi (Group Styles): Put table into float 2017-03-23 12:16:52 -04:00
Mike Gerwitz bff17bdbb6 doc/liza.css: Change font
This imports from Google, which is a privacy risk.  These should be
moved to be hosted locally; their download can be scripted.
2017-03-23 12:16:52 -04:00
Mike Gerwitz f89c311d1d doc/liza.texi: Add predicate system documentation 2017-03-23 12:16:52 -04:00
Mike Gerwitz 5abfedeb54 doc/liza.css: Example block and float styling 2017-03-23 12:16:52 -04:00
Mike Gerwitz b05d48a572 doc/macros.texi (@progxml): Add macro 2017-03-23 12:16:52 -04:00
Mike Gerwitz 8d09c2d8c3 doc/macros.texi: Fix PDF output issues with @maintenance
doc/macros.texi (@maintstart, @maintend): Add macros.
(@maintenance): Use them.
2017-03-23 12:16:52 -04:00
Mike Gerwitz 2ed43ba986 doc/macros.texi (@xmlnode, @xmlattr): Add macros 2017-03-23 12:16:52 -04:00
Mike Gerwitz 637ae01e95 doc/macros.texi (@tip): Add macro
doc/liza.css: Add tip notice styling.
2017-03-23 12:16:52 -04:00
Mike Gerwitz 3dfde49f76 doc/design.texi (Program UI): Add notices
(Client): Add reference to Program UI in notice.
2017-03-23 12:16:52 -04:00
Mike Gerwitz b7adc3b844 doc/macros.texi (@refactornotice): Add macro 2017-03-23 12:16:52 -04:00
Mike Gerwitz 2475cc37a6 doc/macros.texi (@srcrefraw): Add macro
I do not think Texinfo supports optional macro arguments.
2017-03-23 12:16:52 -04:00
Mike Gerwitz a7368d1b52 doc/design.texi (Program): Add matinenance and mv notices 2017-03-23 12:16:52 -04:00
Mike Gerwitz f93539a827 doc/macros.texi (@mvnotice): Add macro 2017-03-23 12:16:52 -04:00
Mike Gerwitz 87fb6277f7 doc/design.texi (Client): Add maintenance concerns 2017-03-23 12:16:52 -04:00
Mike Gerwitz 041cde783a doc/design.texi (Assertions): Add maintenance concerns 2017-03-23 12:16:52 -04:00
Mike Gerwitz 0e29ddd5eb doc/design.texi (Design & Architecture): Convert note to notice 2017-03-23 12:16:52 -04:00
Mike Gerwitz a700d275de doc/design.texi (Managing Error State): Add section text 2017-03-23 12:16:52 -04:00
Mike Gerwitz e477b15298 Add @srcref to manual
doc/macros.texi (@srcref): Add macro.
2017-03-23 12:16:52 -04:00