Minor documentation and UI tweaks.

master
Pacman Ghost 3 years ago
parent b0ad9fcad8
commit 359d9f9108
  1. 2
      asl_rulebook2/webapp/static/MainApp.js
  2. 3
      asl_rulebook2/webapp/static/css/MainApp.css
  3. 6
      asl_rulebook2/webapp/static/css/global.css
  4. BIN
      asl_rulebook2/webapp/static/images/blockquote.png
  5. BIN
      asl_rulebook2/webapp/static/images/favicon.ico
  6. BIN
      asl_rulebook2/webapp/static/images/watermark.png
  7. 2
      asl_rulebook2/webapp/static/prepare.js
  8. 4
      doc/extend.md
  9. 4
      doc/prepare.md

@ -269,7 +269,7 @@ gMainApp.component( "main-app", {
}
}
// update the UI
$( "#watermark" ).css( "opacity", 0.15 ) ;
$( "#watermark" ).css( "opacity", 0.1 ) ;
this.$nextTick( () => {
$( "#query-string" ).focus() ; // nb: because autofocus on the <input> doesn't work :-/
} ) ;

@ -7,9 +7,8 @@
#watermark {
position: absolute ; right: -25px ; bottom: 2px;
width: 200px ; height: 200px ;
width: 208px ; height: 219px ;
background: url(../images/watermark.png) left bottom no-repeat ; background-size: 100% ;
transform: scaleX(-1) ;
opacity: 0 ; z-index: -99 ;
transition: opacity 10s ;
}

@ -20,6 +20,12 @@ ul ul ul { list-style-image: url(../images/bullet3.png) ; }
.auto-ruleid { color: red ; }
.auto-ruleid:hover { background: #ffffcc ; }
span.pre { font-family: monospace ; }
blockquote {
margin: .5em 1em .75em 1em ; padding: 5px 5px 5px 15px ;
border: 1px solid #ddd ; background: #fffff0 ;
background-image: url( "../images/blockquote.png" ) ; background-position: 2px 5px ; background-repeat: no-repeat ;
font-style: italic ;
}
/* notification balloons */
#growls-br { bottom: 0 ; right: 0 ; max-height: 40% ; }

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 284 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 622 KiB

After

Width:  |  Height:  |  Size: 55 KiB

@ -309,7 +309,7 @@ gPrepareApp.component( "download-panel", {
</div>
<div class="info">
You can edit these files directly, if you want to make changes.
<p> If you want to make changes permanent (so they happen if you redo this preparation process), check out the files in <span class="pre">$/asl_rulebook2/extract//data/</span>. </p>
<p> If you want to make changes permanent (so they happen if you redo this preparation process), check out the files in <span class="pre">$/asl_rulebook2/extract/data/</span>. </p>
</div>
</div>`,

@ -6,7 +6,7 @@ To add rules for a module already referenced by the ASLRB index (e.g. RB or BR:T
Then, write a targets file `ASL Rulebook (xxx).targets`, that describes where each rule lives within the PDF. As an example, take a look at the `ASL Rulebook.targets` file that was extracted for you.
*NOTE: Only the page number is required, the X/Y position on the page is optional.*
*NOTE: For each rule, only the page number is required; the X/Y position on the page is optional.*
Finally, bookmarks need to be created in the PDF for each rule, so that the program can jump directly to each rule:
```
@ -16,7 +16,7 @@ Finally, bookmarks need to be created in the PDF for each rule, so that the prog
--yoffset 5 \
--output /tmp/xxx-prepared.pdf
```
Save the prepared file as `ASL Rulebook (xxx).pdf`, and the targets file, in your data directory, and restart the server.
Save the prepared file as `ASL Rulebook (xxx).pdf` in your data directory, together with the targets file, then restart the server.
Optionally, you can also provide:
- a `ASL Rulebook (xxx).chapters` file (to be able to browse the PDF in the *Chapters* panel)

@ -21,7 +21,7 @@ The first step is to extract the information we need from the eASLRB PDF.
--save-vo-notes /tmp/prepared/ASL\ Rulebook.vo-notes \
--progress
```
This extracts the information we need, and saves it in the 4 data files.
This extracts the information we need, and saves it in the 5 data files.
### Prepare the PDF
@ -53,7 +53,7 @@ This rotates any landscape pages, so that the browser shows pages at the correct
### Using the prepared files
You should now have 5 files (the 4 extracted data files, plus the fixed-up PDF), which can be passed in to the program e.g.
You should now have 6 files (the 5 extracted data files, plus the fixed-up PDF), which can be passed in to the program e.g.
```
./run-container.sh \
--port 5020 \

Loading…
Cancel
Save