sharpetronics/hypermedia-systems
1
0
Fork 0
mirror of https://github.com/bigskysoftware/hypermedia-systems.git synced 2025-12-02 00:03:07 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #72 from outofphase/main

Browse Source 
Suggested wording changes
This commit is contained in:
1cg 2023-06-02 15:12:31 -05:00 committed by GitHub
commit f41d2cbcf9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
book/CH01_HypermediaAReintroduction.adoc
View File

@ -65,7 +65,7 @@ hypertexts such as HTML, the Hypertext Markup Language, or HXML, a hypertext us
system. system.
Hypertexts like HTML function alongside other technologies crucial for making an entire hypermedia system work: network Hypertexts like HTML function alongside other technologies crucial for making an entire hypermedia system work: network
protocols like HTTP, other media types such as images, videos, hypermedia servers (i.e., servers providing hypermedia APIs), protocols like HTTP, other media types such as images and videos, hypermedia servers (i.e., servers providing hypermedia APIs),
sophisticated hypermedia clients (e.g., web browsers), and so on. sophisticated hypermedia clients (e.g., web browsers), and so on.
Because of this, we prefer the broader term _hypermedia systems_ when describing the underlying architecture of Because of this, we prefer the broader term _hypermedia systems_ when describing the underlying architecture of

2
book/CH02_ComponentsOfAHypermediaSystem.adoc
View File

@ -667,7 +667,7 @@ not encoded in the response, but rather conveyed through a mix of raw data and s
API documentation. API documentation.
Furthermore, in the majority of front end SPA frameworks today, this contact information would live _in memory_ in a Furthermore, in the majority of front end SPA frameworks today, this contact information would live _in memory_ in a
JavaScript object representing a model of the contact. The DOM would be updated based on changes to this model, that JavaScript object representing a model of the contact, while the page data is held in the browser's https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model[Document Object Model] (DOM). The DOM would be updated based on changes to this model, that
is, the DOM would "`react`" to changes to this backing JavaScript model. is, the DOM would "`react`" to changes to this backing JavaScript model.
This approach is certainly _not_ using Hypermedia As The Engine Of Application State: rather, it is using a JavaScript This approach is certainly _not_ using Hypermedia As The Engine Of Application State: rather, it is using a JavaScript

6
book/CH03_BuildingASimpleWebApplication.adoc
View File

@ -24,7 +24,7 @@ we wish we could write this book for every possible stack out there, in the inte
For this book we are going to use the following stack: For this book we are going to use the following stack:
* https://www.python.org/[Python] as our programming language. * https://www.python.org/[Python] as our programming language.
* https://palletsprojects.com/p/flask/[Flask] as our web framework, allowing us to connect HTTP requests to python logic. * https://palletsprojects.com/p/flask/[Flask] as our web framework, allowing us to connect HTTP requests to Python logic.
* https://palletsprojects.com/p/jinja/[Jinja2] for our server-side templating language, allowing us to render HTML responses using a familiar * https://palletsprojects.com/p/jinja/[Jinja2] for our server-side templating language, allowing us to render HTML responses using a familiar
and intuitive syntax. and intuitive syntax.
@ -67,7 +67,7 @@ environment.
Since this book is for learning how to use hypermedia effectively, we'll just briefly introduce Since this book is for learning how to use hypermedia effectively, we'll just briefly introduce
the various technologies we use _around_ that hypermedia. This has some obvious drawbacks: if you aren't comfortable the various technologies we use _around_ that hypermedia. This has some obvious drawbacks: if you aren't comfortable
with Python, for example, some example python code in the book may be a bit confusing or mysterious at first. with Python, for example, some example Python code in the book may be a bit confusing or mysterious at first.
If you feel like you need a quick introduction to the language before diving into the code, we recommend the following If you feel like you need a quick introduction to the language before diving into the code, we recommend the following
books and websites: books and websites:
@ -89,7 +89,7 @@ made. It uses a Python feature called "`decorators`" to declare the route that
a function to handle requests to that route. We'll use the term "`handler`" to refer to the functions associated a function to handle requests to that route. We'll use the term "`handler`" to refer to the functions associated
with a route. with a route.
Let's create our first route definition, a simple "`Hello Flask`" route. In the following python code you will see the Let's create our first route definition, a simple "`Hello Flask`" route. In the following Python code you will see the
`@app` symbol. This is the flask decorator that allows us to set up our routes. Don't worry too much about `@app` symbol. This is the flask decorator that allows us to set up our routes. Don't worry too much about
how decorators work in Python, just know that this feature allows us to map a given _path_ to a particular function how decorators work in Python, just know that this feature allows us to map a given _path_ to a particular function
(i.e., handler). The Flask application, when started, will take HTTP requests and look up the matching handler and (i.e., handler). The Flask application, when started, will take HTTP requests and look up the matching handler and