Text— cph=43— clh=43— css=border-color:green; font-family:helvetica, sans serif; font-size:24pt; font-weight:bold— join=Y— style=129— user-style=Document_Header—

Document Index Help

Text— cph=40— clh=40— css=text-align:right; border-color:green; font-family:courier, monospace; padding-top:0pt; margin-top:-1px— style=64— user-style=Document_Header—

Help / Document Index Help - 8 Dec 2013 17:18

Text— cph=146— clh=94—

The document index is an interactive table of contents. It presents a filtered list of the document's chunks from which you can choose one and go to it in the document. A report of the indexed chunks can be produced, and you can perform a range of actions on all the included chunks (V1.2).

Text— cph=163— clh=94—

You can edit the text and details of the listed chunks in the same way as in the document. Changes made in the index are as though they were made in the editor. The change is applied immediately - there is no〔Update〕and〔Cancel〕. Any changes made in the index are included in the document's edit history however.

Text— cph=94— clh=59—

There is also an index which is part of the Preview, which lets you jump to notable parts of the previewed document [more].

Section— cph=42— clh=42— level=1—

1 What You Can See

Text— cph=94— clh=59—

The screen shows a list of the document chunks which satisfy one or more switches in the Show Menu. The chunks appear in the same order as they are in the document.

Text— cph=215— clh=128—

Matching chunks which are selected in the actual document are shown selected regardless on why the chunk is included. Furthermore the chunk is shown with only the portion of border that chunk has in the actual document. This can give a slightly odd looking display, but serves to indicate where in the selection that chunk is. Similarly chunks which were in view when you entered the index are shown with a grey border, again showing which portion of the visible range the chunk was.

Text— cph=59— clh=42—

Chunks which match the row or content patterns are shown with a bright purple border.

Section— cph=42— clh=42— level=1—

2 What You Can Do

Section— cph=42— clh=42— level=2—

2.1 What You Can't Do

Text— cph=59— clh=42—

While you can edit chunks and their details in the Document Index, you can't:

Section— cph=42— clh=42— level=1—

3 Toolbar Buttons

Table— cph=64— clh=64— css=border:solid black 3px— style=2— series=— title=Toolbar buttons—

TableColumn— cph=44— clh=44— css=— cell-style=width:1cm—

TableColumn— cph=44— clh=44— css=background-color:green—

TableColumn— cph=44— clh=44— css=background-color:white— cell-style=text-align:left—

TableRow— cph=44— clh=44— css=border-bottom:solid gray 1px—

TableRow— cph=44— clh=44— css=border-top:solid gray 1px—

TableRow— cph=44— clh=44— css=border:solid black 3px—

TableRow— cph=44— clh=44— css=border:solid black 3px—

TableRow— cph=44— clh=44— css=border:solid black 3px—

TableRow— cph=44— clh=44— css=—

TableRow— cph=44— clh=44— css=border:solid black 3px—

TableRow— cph=44— clh=44— css=border:solid black 3px—

TableRow— cph=44— clh=44— css=border-top:black solid thin—

TableRow— cph=44— clh=44— css=border:black solid medium—

TableCell— cph=44— clh=44— css=background-color:green— join=Y— style=2— cols=2—

Text— cph=42— clh=42— user-style=Button_Title—

Return

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=42— clh=42— user-style=Button_Description—

Returns to where you were in the document

TableCell— cph=44— clh=44— css=background-color:green— join=Y— style=2— cols=2—

Text— cph=42— clh=42— css=background-color:rgb(82,72,255); color:white— user-style=Button_Title—

Go To


16/01/2013 09:41 - correct colour from code

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=59— clh=42— user-style=Button_Description—

Returns to the document and takes you to your chosen chunk.

TableCell— cph=44— clh=44— css=background-color:green— join=Y— style=2— cols=2—

Text— cph=42— clh=42— css=background-color:rgb(255,255,164); width:2em— style=8— user-style=Button_Title—

?

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=42— clh=42— user-style=Button_Description—

Gives help = this document

TableCell— cph=44— clh=44— id=— css=background-color:green— style=2— cols=2—

Text— cph=42— clh=42— id=- action menu— user-style=Button_Title—

/Extract\

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=94— clh=59— user-style=Button_Description—

Tap to perform the Extract action below, touch and hold to call up a menu of actions which are applied to all the chunks currently included in the index. (V1.2)

TableCell— cph=44— clh=44— css=background-color:white; border-left-style:hidden; border-bottom-style:hidden— join=Y—

Text— cph=42— clh=42—

TableCell— cph=44— clh=44— id=extract— css=border-left:black solid medium— style=2—

Text— cph=42— clh=42— css=— user-style=Button_Title—

Extract

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=59— clh=42— user-style=Button_Description—

Produces a listing of the currently visible chunks and adds it to the end of Scratch.

TableCell— cph=44— clh=44— css=background-color:white; border-left-style:hidden; border-bottom-style:hidden; border-right:black solid medium— join=Y—

Text— cph=42— clh=42—

TableCell— cph=44— clh=44— id=— style=2—

Text— cph=42— clh=42— css=— user-style=Button_Title—

Tab

Text— cph=42— clh=42— css=— user-style=Button_Title—

Untab

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=94— clh=59— user-style=Button_Description—

Applies or removes tabs from all the shown chunks (V1.2).
Note you can also the tab/untab the chunks individually by swiping across them.

TableCell— cph=44— clh=44— css=background-color:white; border-left-style:hidden; border-bottom-style:hidden; border-right:black solid medium— join=Y—

Text— cph=42— clh=42—

TableCell— cph=44— clh=44— id=— style=2—

Text— cph=42— clh=42— css=— user-style=Button_Title—

Paste Styling

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=77— clh=59— user-style=Button_Description—

Pastes the current copied chunk styling to all the shown chunks
(V1.2)

TableCell— cph=44— clh=44— css=background-color:white; border-left-style:hidden; border-bottom-style:hidden; border-right:black solid medium— join=Y—

Text— cph=42— clh=42—

TableCell— cph=44— clh=44— id=— style=2—

Text— cph=42— clh=42— css=— user-style=Button_Title—

Change

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=94— clh=77— user-style=Button_Description—

Changes all the shown chunks to a new chunk type. You get to choose what sort (text, item, etc.)
(V1.2)

TableCell— cph=44— clh=44— css=background-color:white; border-left-style:hidden; border-right:black solid medium— join=Y—

Text— cph=42— clh=42—

TableCell— cph=44— clh=44— id=- alter markup— style=2—

Figure— cph=58— clh=58— style=2— path=Icons/TaskIconUp.png— series=— level=1— caption-flags=16— title=Task Up—

Icons/TaskIconUp.png

Figure— cph=58— clh=58— style=2— path=Icons/ChunkIconIdeaAccepted.png— series=— level=1— caption-flags=16— title=Item accepted—

Icons/ChunkIconIdeaAccepted.png

Figure— cph=58— clh=58— style=2— path=Icons/ChunkIconNoteTypeQuery.png— series=— level=1— caption-flags=16— title=Query Icon—

Icons/ChunkIconNoteTypeQuery.png

Text— cph=42— clh=42— css=color:yellow; font-weight:bold—

etc…

TableCell— cph=44— clh=44— style=2—

Text— cph=146— clh=111— user-style=Button_Description—

Alters the associated markup chunks in the index, in the same manner as adjusting their details [more]. The appropriate buttons are shown for the markup chunk type with the most entries. They have no effect on different chunks.
(V1.2)

TableCell— cph=44— clh=44— css=background-color:green— join=Y— style=2— cols=2—

Text— cph=42— clh=42— id=Show Button— user-style=Button_Title—

Show

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=59— clh=42— user-style=Button_Description—

Pulls up the Show Menu, which lets you change what's included in the index.

TableEnd— cph=50— clh=50—

Section— cph=42— clh=42— id=- the show menu— level=1—

4 The Show Menu

Text— cph=94— clh=59—

The Show Menu consists of a number of switches to include different chunks into the index. A chunk is included if it matches any of the switches.

Text— cph=94— clh=77—

The text is shown in yellow when the switch is on, and grey when it is off. The switches themselves are ghosted if they don't apply, i.e. the document doesn't contain any of those chunks.

Table— cph=64— clh=64— style=2— series=— title=Show switches—

TableColumn— cph=44— clh=44— css=background-color:green; width:2.25in—

TableColumn— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=42— clh=42— user-style=Switch_Button_Text—

Selection

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=59— clh=42— user-style=Button_Description—

Includes chunks which are currently selected in the document

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=42— clh=42— user-style=Switch_Button_Text—

In View

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=42— clh=42— user-style=Button_Description—

Chunks which were visible in the editor

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=128— clh=128— id=- show chunk type— user-style=Switch_Button_Text—

Tasks
Notes
Ideas
Sections
Figures
Tables

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=77— clh=59— user-style=Button_Description—

Includes that type of chunk. Only the start of tables is included. Sections also includes part chunks.

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=42— clh=42— user-style=Switch_Button_Text—

Tabbed

TableCell— cph=44— clh=44— join=Y— style=2—

Text— cph=42— clh=42— user-style=Button_Description—

Chunks which are tabbed in the actual document

TableCell— cph=44— clh=44— id=Row Pattern Button— style=2—

Text— cph=42— clh=42— css=display:inline-block; float:left; border-color:fuchsia— join=Y— user-style=Button_Title—

#

Text— cph=42— clh=42— css=float:right; color:gray; width:1in— user-style=Button_Title—

row

TableCell— cph=44— clh=44— style=2—

Text— cph=94— clh=59— id=- row pattern— user-style=Button_Description—

Chunks which match the given row pattern [more (below)] Matching ranges of chunks are shown with a bright purple border.

    Item— cph=59— clh=42— level=1— format=12— user-style=Button_Description—

  • Tap on 〔#〕to include/exclude matching rows from the index

  • Item— cph=59— clh=42— level=1— format=12— user-style=Button_Description—

  • Tap on 〔row〕to enter a row number or range of numbers

TableCell— cph=44— clh=44— style=2—

Text— cph=42— clh=42— css=display:inline-block; float:left; border-color:fuchsia— join=Y— user-style=Button_Title—

?

Text— cph=42— clh=42— css=float:right; color:gray; width:1in— user-style=Button_Title—

content

TableCell— cph=44— clh=44— style=2—

Text— cph=111— clh=77— user-style=Button_Description—

Chunks whose text content matches the given pattern [more (below)] . Matching chunks are shown with a bright purple border.

    Item— cph=59— clh=42— level=1— format=12— user-style=Button_Description—

  • Tap on 〔?〕to include/exclude chunks with matching content from the index.

  • Item— cph=59— clh=42— level=1— format=12— user-style=Button_Description—

  • Tap on 〔content〕to enter a new content pattern to match against.

TableEnd— cph=50— clh=50—

Section— cph=42— clh=42— id=- row patterns— level=1—

5 Row Patterns

Text— cph=215— clh=128—

The row pattern specifies which rows to include. The row number is just the index position of the chunk, so the first chunk in the document is #1. The row number is shown in the details view of a chunk [more] , and is also used in the History [more] and in the details of each file found as a result of a content search by Find In Files [more].

Text— cph=42— clh=42—

Valid row patterns include:

    Item— cph=77— clh=77— level=1— format=8—

    5
    5 & 7
    5-7

Text— cph=59— clh=59—

You can string patterns together as you wish using commas or spaces, so ‘1-3, 5 & 10’ is fine.


(null)
27/01/2013 08:06 - Changed to text

Text— cph=77— clh=59—

Return to the Show Menu to see how what you have entered has been interpreted if there's any doubt.

Section— cph=42— clh=42— id=- content patterns— level=1—

6 Content Patterns

Text— cph=232— clh=128—

At its simplest, the content matching is a text search - so searching for ‘the’ will include chunks containing any of the words ‘the’ or ‘then’ or ‘other’, etc. However, if several words are specified, rather than being a literal text search, every word is treated separately. So searching for ‘fred dave’ will include any chunk which mentions ‘fred’ and ‘dave’ anywhere within it. If you want to search for just one whole word, simply put a space after it; ‘the ’ will find ‘the’ even amongst punctuation, whilst ignoring ‘then’, etc.

Text— cph=94— clh=77—

Words in lowercase match any case. Any capitalised letters only match themselves though. So ‘ipod’ will match iPod, ipod and IPOD, but iPod only matches iPod (and not ipod).

Text— cph=128— clh=77—

Use plain double-quotes to match specific phrases, e.g. "ice cream", and double double-quotes to match a quoted phrase, so ""hello"", will only match ‘ "hello" ’ and not ‘hello’. Note though, plain double-quotes (") are not the same as speech marks (“ & ”).

Section— cph=42— clh=42— id=- search qualifiers— level=1—

7 Search Qualifiers

Text— cph=77— clh=59—

You can precede the words to find by one or more qualifiers to indicate where to look. Qualifiers are case insensitive.

Text— cph=42— clh=42—

Valid qualifiers are:

Table— cph=64— clh=64— style=2— series=— title=Content pattern qualifiers—

TableColumn— cph=44— clh=44— css=text-align:right— style=1—

TableColumn— cph=44— clh=44— style=1—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableRow— cph=44— clh=44—

TableCell— cph=44— clh=44— join=Y—

Text— cph=180— clh=180— user-style=Button_Description—

task:
idea:
note:
text:
item:
section:
part:
figure:
table:

TableCell— cph=44— clh=44— join=Y—

Text— cph=94— clh=59— user-style=Button_Description—

Limits the search to just that type of chunk. These qualifiers can be stacked, so ‘text:item:hello’ looks for ‘hello’ in both text and item chunks.

TableCell— cph=44— clh=44— join=Y—

Text— cph=59— clh=59— user-style=Button_Description—

title:
code:

TableCell— cph=44— clh=44— join=Y—

Text— cph=77— clh=59— user-style=Button_Description—

Limits the search to text chunks which are set to that text type in their details
(V1.2)

TableCell— cph=44— clh=44— join=Y—

Text— cph=42— clh=42— user-style=Button_Description—

markup:

TableCell— cph=44— clh=44— join=Y—

Text— cph=59— clh=42— user-style=Button_Description—

Limits the search to any of the markup chunks (equivalent to task:idea:note:)

TableCell— cph=44— clh=44— join=Y—

Text— cph=59— clh=59— user-style=Button_Description—

to do:
todo:

TableCell— cph=44— clh=44— join=Y—

Text— cph=77— clh=59— user-style=Button_Description—

Limits the search to any of the task chunks which are outstanding
(V1.2)

TableCell— cph=44— clh=44— join=Y—

Text— cph=42— clh=42— user-style=Button_Description—

content:

TableCell— cph=44— clh=44— join=Y—

Text— cph=59— clh=42— user-style=Button_Description—

Limits the search to non-markup chunks, so text, items, sections etc.

TableCell— cph=44— clh=44— join=Y—

Text— cph=42— clh=42— user-style=Button_Description—

tabbed:

TableCell— cph=44— clh=44— join=Y—

Text— cph=42— clh=42— user-style=Button_Description—

Restricts the search to tabbed chunks only

TableCell— cph=44— clh=44— join=Y—

Text— cph=59— clh=59— id=- chunkID— user-style=Button_Description—

id:
chunkid:

TableCell— cph=44— clh=44— join=Y—

Text— cph=94— clh=59— user-style=Button_Description—

Restricts the search to check just the Chunk ID setting. A search of just ‘id:’ will return all chunks with a Chunk ID set to something (i.e. non-blank)

TableCell— cph=44— clh=44— join=Y—

Text— cph=59— clh=59— id=ChunkID— user-style=Button_Description—

link:
links:

TableCell— cph=44— clh=44— join=Y—

Text— cph=111— clh=77— user-style=Button_Description—

Restricts the search to check just the Link setting. A search of just ‘link:’ will return all chunks with their Link set to something (i.e. non-blank). Currently this does not return inline links, only those set in the chunk's details.

TableCell— cph=44— clh=44— join=Y—

Text— cph=42— clh=42— user-style=Button_Description—

style:

TableCell— cph=44— clh=44— join=Y—

Text— cph=94— clh=59— user-style=Button_Description—

Directs the search to check the style setting for each chunk. Note styles are stored as plain CSS properties. A search of ‘style:’ will return all chunks which have something set.

TableCell— cph=44— clh=44— join=Y—

Text— cph=42— clh=42— user-style=Button_Description—

journal:

TableCell— cph=44— clh=44—

Text— cph=94— clh=77— user-style=Button_Description—

Directs the search to look in the journal of each chunk. Note that journal content is not included in a normal search. A search of ‘journal:’ will return all chunks with a non-empty journal.

TableCell— cph=44— clh=44— join=Y—

Text— cph=77— clh=77— user-style=Button_Description—

pattern:
button:
reaction:

TableCell— cph=44— clh=44— join=Y—

Text— cph=111— clh=77— user-style=Button_Description—

Limits the search to just that type of chunk - relevant to searching in a resource file. ‘Button:’ and ‘Pattern:’ are synonymous, either matches either. Any of these by themselves will return all the chunks of that type.

TableCell— cph=44— clh=44— join=Y—

Text— cph=59— clh=59— user-style=Button_Description—

on:
off:

TableCell— cph=44— clh=44— join=Y—

Text— cph=111— clh=77— user-style=Button_Description—

Restricts the search to chunks which are set to the either on (active) or off. This applies to button, pattern, and reaction chunks as used in resource files. Searching for ‘off:’ or ‘on:’ returns all chunks set accordingly.

TableCell— cph=44— clh=44— join=Y—

Text— cph=42— clh=42— user-style=Button_Description—

stimulus:

TableCell— cph=44— clh=44— join=Y—

Text— cph=77— clh=59— user-style=Button_Description—

Restricts the search to just the stimulus of reaction chunks. A normal search checks both the reaction and stimulus of reaction chunks.

TableEnd— cph=50— clh=50—

Text— cph=215— clh=128—

When using a content pattern, and especially if it includes a qualifier, it is important to realise that it might not be the only reason a chunk is included in the index, as the other switches remain active. For example a search of ‘tabbed:pizza’ will include all tabbed cells which mention the word ‘pizza’, but any other tabbed cells will also be included if the Tabbed switch is on. Of course only the tabbed chunks mentioning pizza will have the bright purple border around them.

Section— cph=42— clh=42— join=Y— level=1—

8 Subtle Features

Text— cph=146— clh=94—

The Edit Menu's text search [more] is still available when editing any chunk in the index. It searches the text of just the currently included chunks independently of why they were included (specifically independently of the content pattern matching).

Text— cph=77— clh=59— style=16—

This is a ProseEdit Help File. You can edit as desired to add notes. If you delete the file, it will be replaced the next time ProseEdit starts up.