Indicating Code Sample Line Breaks

[Art Campbell]

And also, if they're using a PDF, it screws up the ability to
cut-and-paste a line if they want to.

Art

On Nov 29, 2007 3:09 PM, Neil Tubb <neil.tubb at solacesystems.com> wrote:
> Thanks for the replies everyone! All I was asking about was lines that
> wrapped...sounds like most think that simply indenting will cover it
> off. It was a developer that told me to put in a visual indicator...why
> would this "bite me"? Very odd.
>
> -----Original Message-----
> From: framers-bounces at lists.frameusers.com
>
> [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Kelly
> McDaniel
> Sent: Thursday, November 29, 2007 3:05 PM
> To: framers at frameusers.com
> Subject: RE: Indicating Code Sample Line Breaks
>
> Put the code in a cell or leave it in the body, makes no difference to
> the user.
>
> Code in the body of the text is easier to maintain in docs.
>
> Indent the line continuation.
>
> Do not put any character at the end of a broken line.
> Coders know that lines break.
> Non-code characters intended to visually indicate a line break will bite
> you.
>
> If the first word of a following line tries to jump back up to the end
> of the previous line, force it to the following line with invisible
> space(s) as needed.
>
> The point of the code sample is to present it in a manner that's
> acceptable to coders.
>
>
>
> -----Original Message-----
> From: framers-bounces at lists.frameusers.com
> [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Art Campbell
> Sent: Thursday, November 29, 2007 1:13 PM
> To: Neil Tubb
> Cc: framers at frameusers.com
> Subject: Re: Indicating Code Sample Line Breaks
>
> I put each line of code into a single cell -- if you're doing that,
> just set an indent for the subsequent lines. I've never put anything
> at the end of the line and never had anyone fail to understand that a
> hanging first line and indented following lines indicated that the
> line wrapped.
>
> Manually adding a special character would be possible, but a real PITA
> to maintain...
>
> If you had to do it, you could create a second column to the right of
> the code sample just wide enough for a character or two and create a
> paragraph tag that would generate the symbol. And then only use that
> character format in the cell for lines that wrap. That would still
> allow you to cut and paste freely in the "code" column.
>
> Art
>
> On Nov 29, 2007 1:59 PM, Neil Tubb <neil.tubb at solacesystems.com> wrote:
> > Hi all,
> >
> >
> >
> > Please help me...I'm working on an SDK programming guide, and I have
> > some sample code lines that are just too long. I am told I need to
> > indicate that the lines are breaking with some kind of an carriage
> > return arrow icon, and then indent the following line.
> >
> >
> >
> > Does anyone have any good ideas on how to do this in FrameMaker? I'm
> > using Frame 7.1 on Windows XP. My code samples are done in a single
> > table cell.
> >
> >
>
> --
> Art Campbell
> art.campbell at gmail.com
>   "... In my opinion, there's nothing in this world beats a '52 Vincent
>                and a redheaded girl." -- Richard Thompson
>                              No disclaimers apply.
>                                      DoD 358

-- 
Art Campbell                                             art.campbell at gmail.com
  "... In my opinion, there's nothing in this world beats a '52 Vincent
               and a redheaded girl." -- Richard Thompson
                             No disclaimers apply.
                                     DoD 358