Typo in AutoDocs/amigaguide_dtc.doc

Have a question about our Software Developer Kit? Ask them here.

Typo in AutoDocs/amigaguide_dtc.doc

Postby Raziel » Sat May 18, 2019 1:11 pm

On line 332-334 is a typo
Code: Select all
          @{FG <color>}
          Used to change the foreground color.  The same colors can be
          used as in the FG command.

On line 334 is should be
Code: Select all
          used as in the BG command.

as the whole paragraph is meant to paraphrase the BG entry (lines 305-314)
Code: Select all
          @{BG <color>}
          Used to change the background text color.  Color can be:

            Text
            Shine
            Shadow
            Fill
            FillText
            Background
            Highlight
If slaughterhouses had glass walls, everyone would be a vegetarian. ~ Sir Paul McCartney
-
Did everything just taste purple for a second? ~ Philip J. Fry
-
Ain't got no cash, ain't got no style, ladies vomit when I smile. ~ Dr. John Zoidberg
User avatar
Raziel
 
Posts: 914
Joined: Sat Jun 18, 2011 5:00 pm
Location: a story that hasn't been written yet

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby nbache » Sat May 18, 2019 4:16 pm

Confirmed.

I've made a Bugzilla report for it, quoting your above post.

Thanks for reporting!

Best regards,

Niels
User avatar
nbache
Beta Tester
Beta Tester
 
Posts: 1382
Joined: Mon Dec 20, 2010 8:25 pm
Location: Copenhagen, Denmark

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby Raziel » Sat May 18, 2019 4:25 pm

Thank you, nbache

The next one, i missed earlier, same file

line 285-288
Code: Select all
          @{<label> <command>}
          Indicate a textual link point.  Can be anywhere in a line.
          Starting with 3.0, AmigaGuide can can link to graphics,
          sounds, animations and other DataTypes.

Line 287 holds an extra "can"
If slaughterhouses had glass walls, everyone would be a vegetarian. ~ Sir Paul McCartney
-
Did everything just taste purple for a second? ~ Philip J. Fry
-
Ain't got no cash, ain't got no style, ladies vomit when I smile. ~ Dr. John Zoidberg
User avatar
Raziel
 
Posts: 914
Joined: Sat Jun 18, 2011 5:00 pm
Location: a story that hasn't been written yet

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby Raziel » Sat May 18, 2019 4:29 pm

And another one

Line 298-300
Code: Select all
          @{APEN}
          Use to change the foreground color to a specific pen number.
          New for V40.

Line 299
"Use" should be "Used"

Line 321-323
Code: Select all
          @{BPEN}
          Use to change the background color to a specific pen number.
          New for V40.

Line 322
"Use" should be "Used"
Last edited by Raziel on Sat May 18, 2019 4:43 pm, edited 1 time in total.
If slaughterhouses had glass walls, everyone would be a vegetarian. ~ Sir Paul McCartney
-
Did everything just taste purple for a second? ~ Philip J. Fry
-
Ain't got no cash, ain't got no style, ladies vomit when I smile. ~ Dr. John Zoidberg
User avatar
Raziel
 
Posts: 914
Joined: Sat Jun 18, 2011 5:00 pm
Location: a story that hasn't been written yet

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby Raziel » Sat May 18, 2019 4:38 pm

One that i'm unsure of

Lines 199-204
Code: Select all
         @SMARTWRAP
          This is used to indicate that the text of the database is to
          wordwrapped using a more intelligent algorithm than @wordwrap.
          A paragraph doesn't need to be restricted to one physical
          line, but paragraphs must be separated by two line feeds.
          New for V40.

Line 200
...the text of the database is to be
wordwrapped...

and
Lines 262-266
Code: Select all
          @SMARTWRAP
          This is used to indicate that the text of the node is to
          wordwrapped using a more intelligent algorithm than @wordwrap.
          A paragraph doesn't need to be restricted to one physical
          line, but paragraphs must be separated by two line feeds.
          New for V40.

Line 263
...the text of the node is to be
wordwrapped...

Since english is not my first language, please confirm or deny, as it does sound off to my ears the way it is now.
Maybe losing the "to" in that lines would fix it as well?
If slaughterhouses had glass walls, everyone would be a vegetarian. ~ Sir Paul McCartney
-
Did everything just taste purple for a second? ~ Philip J. Fry
-
Ain't got no cash, ain't got no style, ladies vomit when I smile. ~ Dr. John Zoidberg
User avatar
Raziel
 
Posts: 914
Joined: Sat Jun 18, 2011 5:00 pm
Location: a story that hasn't been written yet

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby Raziel » Sat May 18, 2019 4:50 pm

And finally
It hurts my eyes to see different versions of "word wrap", so i'm going with the flow and change it to the one version used most in the text (wordwrap)

Line 316-319
Code: Select all
          @{BODY}
          Indicate that the following text is the body of the document.
          Word wrap will be turned back on if it is the default.  New
          for V40.

Line 318
wordwrap instead of "Word wrap"

and

Line 328-330
Code: Select all
          @{CODE}
          Indicate that the following text is not to be word-wrapped.
          New for V40.

Line 329
wordwrap instead of "word-wrapped"



Thank you and good night
If slaughterhouses had glass walls, everyone would be a vegetarian. ~ Sir Paul McCartney
-
Did everything just taste purple for a second? ~ Philip J. Fry
-
Ain't got no cash, ain't got no style, ladies vomit when I smile. ~ Dr. John Zoidberg
User avatar
Raziel
 
Posts: 914
Joined: Sat Jun 18, 2011 5:00 pm
Location: a story that hasn't been written yet

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby nbache » Sat May 18, 2019 4:51 pm

I've linked to this thread from the bug report and asked whoever fixes it to read your subsequent reports and take care of those as well.

(BTW: Personally, I'd choose "word wrap", but English isn't my first language either.)

Thanks again!

Best regards,

Niels
User avatar
nbache
Beta Tester
Beta Tester
 
Posts: 1382
Joined: Mon Dec 20, 2010 8:25 pm
Location: Copenhagen, Denmark

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby Raziel » Sat May 18, 2019 5:29 pm

Thank you Niels
If slaughterhouses had glass walls, everyone would be a vegetarian. ~ Sir Paul McCartney
-
Did everything just taste purple for a second? ~ Philip J. Fry
-
Ain't got no cash, ain't got no style, ladies vomit when I smile. ~ Dr. John Zoidberg
User avatar
Raziel
 
Posts: 914
Joined: Sat Jun 18, 2011 5:00 pm
Location: a story that hasn't been written yet

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby broadblues » Sun May 19, 2019 1:29 pm

Fixed these up and clarified the issue under discussion on amigans.net

This section of thye docs now read

Code: Select all
    COMMANDS
        Commands must start in the very first column of a line, and
        can be the only thing on the line.  If a line begins with an
        @ sign, then it is interpreted as a command.

        The following commands can be used in the global section
        of a database.

          @$VER: <AmigaDOS version string>
          Specify the version of the database.  This command
          must always be in upper-case.

          @(C) <copyright>
          Specify the copyright notice for the database.

          @AUTHOR <name>
          Specify the author of the database.

          @DATABASE <name>
          Must be the very first line of an AmigaGuide document.

          @DNODE <name>
          Indicates the start of a dynamic node.  The AmigaGuide system
          uses the callback hooks to obtain the document from a document
          provider.  This is obsolete, do not use.

          @FONT <name> <size>
          Specify the font to use for the database.

          @HEIGHT <chars>
          How high, in characters, the largest document is.

          @HELP <name/node>
          Specify the name of the help node, which will be accessed
          by the Help button.  Can be a node in an external database.

          @INDEX <name/node>
          Specify the name of the index node, which will be accessed
          by the Index button.  Can be a node in an external database.

          @MACRO <name> <commands>
          This is used to construct a macro.  A macro can be used the
          same way as an attribute command, and can only consist of
          other attribute commands or macros.  The macro list is
          searched before the attribute command list is searched.  This
          is new for V40.

              @macro icom "@{i}$1 @{ui}"

              ...

              This is an @{icom "example"} of macro.

          @MASTER <path>
          Complete path of the source document used to define this
          AmigaGuide database.

          @NODE <name> <title>
          Indicate the start of a node (page/article/section). The first
          node, or main node, must be named MAIN.  MAIN must be the master
          table of contents for the database.

          @ONCLOSE <rxcommand>
          This is used to specify an ARexx macro file to execute when
          the database is closed.  The return value of the script has no
          effect on the database.  New for V40.

          @ONOPEN <rxcommand>
          This is used to specify an ARexx macro file to execute when
          the database is opened.  If the script returns an error, then
          the database will not be opened.  New for V40.

          @REM <remark>
          @REMARK <remark>
          This is used to place remarks in the database.  These remarks
          are not displayed to the user.

          @SMARTWRAP
          This is used to indicate that the text of the database is to
          word wrapped using a more intelligent algorithm than @wordwrap.
          A paragraph doesn't need to be restricted to one physical
          line, but paragraphs must be separated by two line feeds.
          New for V40.

          @TAB <num>
          Number of spaces in a tab.  Defaults to 8.  New for V40.

          @WIDTH <chars>
          How wide, in characters, the largest document is.

          @WORDWRAP
          Turn on word wrapping for the whole database.  A paragraph must
          be restrained to one physical line.

        The following commands can be used within nodes of a database.

          \
          A backslash is the escape character.  A backslash in front of
          the @ sign is used to escape it. The backslash has no effect
          as an escape character inside commands such as @ONOPEN or
          @{".." LINK ..}; in cases like these it is treated as a
          regular character.
          Please note that AmigaGuide V35 does not treat the backslash
          character as an escape character.

          @ENDNODE <name>
          Indicate the end of a node.  Must start at the beginning of a
          line.

          @FONT <name> <size>
          Specify the font to use for the node.

          @HELP <name/node>
          Specify the name of the help node, which will be accessed
          by the Help button.  Can be a node in an external database.

          @INDEX <name/node>
          Specify the name of the index node, which will be accessed
          by the Index button.  Can be a node in an external database.

          @KEYWORDS <keywords>
          Keywords of the node.  Someday when searching is
          reimplemented, there will be a keyword search.

          @NEXT <node name>
          Node to display when the user selects "Browse >"

          @ONCLOSE <rxcommand>
          This is used to specify an ARexx macro file to execute when
          the node is closed.  The return value of the script has no
          effect on the node.  New for V40.

          @ONOPEN <rxcommand>
          This is used to specify an ARexx macro file to execute when
          the node is opened.  If the script returns an error, then
          the node will not be opened.  New for V40.

          @PREV <node name>
          Node to display when the user selects "< Browse"

          @SMARTWRAP
          This is used to indicate that the text of the node is to
          word wrapped using a more intelligent algorithm than @wordwrap.
          A paragraph doesn't need to be restricted to one physical
          line, but paragraphs must be separated by two line feeds.
          New for V40.

          @TAB <num>
          Number of spaces in a tab.  Defaults to 8.  New for V40.

          @TITLE <title>
          Title to display in the title bar of the window during the
          display of this node.  Must start at the beginning of a line.

          @TOC <node name>
          Name of the node that contains the table of contents for this
          node.  Defaults to MAIN.  This is the node that is displayed
          when the user presses the "Contents" button.

          @WORDWRAP
          Turn on word wrapping for the node.  A paragraph must
          be restrained to one physical line.

          @{<label> <command>}
          Indicate a textual link point.  Can be anywhere in a line.
          Starting with 3.0, AmigaGuide can link to graphics,
          sounds, animations and other DataTypes. External files need
          a dummy node name.
          Examples:
              @{"BEEPME" BEEP} Screen beep.
              @{"Chapter 2" LINK Chapter2} Link to internal node
              @{"someother.guide" LINK someother.guide/main} link to
                  external guide file.
              @{"mypic" LINK path/to/mypic.ilbm/main} display mypic.ilbm

    ATTRIBUTES
        Following is a list of attributes that can be applied to the
        text of a node.

          @{AMIGAGUIDE}
          Displays the word AmigaGuide in bold followed by the ® symbol.
          New for V40.

          @{APEN}
          Used to change the foreground color to a specific pen number.
          New for V40.

          @{B}
          Turn bold on.

          @{BG <color>}
          Used to change the background text color.  Color can be:

            Text
            Shine
            Shadow
            Fill
            FillText
            Background
            Highlight

          @{BODY}
          Indicate that the following text is the body of the document.
          Word wrap will be turned back on if it is the default.  New
          for V40.

          @{BPEN}
          Used to change the background color to a specific pen number.
          New for V40.

          @{CLEARTABS}
          Restore the default tab stops.  New for V40.

          @{CODE}
          Indicate that the following text is not to be word wrapped.
          New for V40.

          @{FG <color>}
          Used to change the foreground color.  The same colors can be
          used as in the BG command.

          @{I}
          Turn italic on.

          @{JCENTER}
          Turn on centering.  New for V40.

          @{JLEFT}
          Turn on left justification.  New for V40.

          @{JRIGHT}
          Turn on right justification.  New for V40.

          @{LINDENT}
          Set the number of spaces to indent the body of a paragraph.
          New for V40.

          @{LINE}
          Force a line feed without starting a new paragraph.  New for V40.

          @{PAR}
          Used to indicate the end of a paragraph.  This is the same as
          two sequential LF's in the source file.  New for V40.

          @{PARD}
          Restore the default settings for a paragraph.  Text pen to 1,
          background to 0, normal font, and no indentation.  New for V40.

          @{PARI}
          Set the number of spaces to indent the first line of a
          paragraph relative to the normal paragraph indentation.  The
          value may be a negative number.  New for V40.

          @{PLAIN}
          Used to turn off all @{B}, @{I}, and @{U} commands.  New for
          V40.

          @{SETTABS <n> ... <n>}
          This is used to establish tab stops.  New for V40.

          @{TAB}
          The same as character 9 in the source file.  New for V40.

          @{U}
          Turn underline on.

          @{UB}
          Turn bold off.

          @{UI}
          Turn italic off.

          @{UU}
          Turn underline off.

User avatar
broadblues
AmigaOS Core Developer
AmigaOS Core Developer
 
Posts: 590
Joined: Sat Jun 18, 2011 3:40 am
Location: Portsmouth, UK

Re: Typo in AutoDocs/amigaguide_dtc.doc

Postby nbache » Tue May 21, 2019 4:16 pm

@broadblues:

Thanks.

But before Raziel spots it ;-):

You missed the missing "be" in the first line of each of the two SMARTWRAP sections. I'll note it in the BZ.

Best regards,

Niels
User avatar
nbache
Beta Tester
Beta Tester
 
Posts: 1382
Joined: Mon Dec 20, 2010 8:25 pm
Location: Copenhagen, Denmark

Next

Return to SDK Support

Who is online

Users browsing this forum: No registered users and 1 guest