From: MikeMannix Date: Fri, 7 Sep 2001 04:04:37 +0000 (+0000) Subject: none X-Git-Url: https://git.openafs.org/?p=openafs-wiki.git;a=commitdiff_plain;h=de925cdf80984e92faf55f44b215c2c58c00a5ac none --- diff --git a/TWiki/FileAttachment.mdwn b/TWiki/FileAttachment.mdwn index 7758d83..9d582ee 100644 --- a/TWiki/FileAttachment.mdwn +++ b/TWiki/FileAttachment.mdwn @@ -4,7 +4,7 @@
  • What Are Attachments Good For?
  • Uploading Files
    • @@ -22,37 +22,46 @@ ## File Attachments -Each topic can have files attached to it. This is similar to an e-mail attachment. Just use your browser to upload or download a file. Attachments are stored under revision control - no upload is lost. +Each topic can have files attached to it, similar to an email attachment. Use your browser to upload or download a file. Attachments are stored under revision control: uploads can never be lost, and changes can be made to files with a rollback option to any previous version always available. ### What Are Attachments Good For? +File Attachments can be used to create powerful groupware solutions - file sharing, document management - and for speedy Web authoring. + #### Document Management System -- **_document management system: distribution, revision_** +- You can use Attachments to store and retrieve documents (in any format, with associated graphics, and other media files); attach documents to specific TWiki topics; collaborate on documents with full revision control; distribute documents on a [[need-to-know basis|Main/WebHome#AttachmentAccess]] using; create a central reference library that's easy to access and manage by an entire user group. #### File Sharing -- **_share files: applications, data files; recommended for light use_** +- For file sharing, [[FileAttachments]] on a series of topics can be used to quickly create a well-documented, categorized digital download center for all types of files: documents; graphics and other media; drivers and patches; applications; anything you can safely upload! -#### Page Content +#### Web Authoring -- **_on-site use: linking to graphics, docs_** +- Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to embed on a page) and place them anywhere in on a single page, or for use across a web, or site-wide. + - **_NOTE:_** You can also add graphics - any files - directly, typically by FTP upload. This requires server access, and may be more convenient if a large number of files, or a particular directory location, is required. These files can't be managed using browser-based Attachment controls. ### Uploading Files -- To upload: Click on the Attach link at the bottom of each page. A form is shown where you can browse for a file and upload it. The uploaded file will show up in the [[File Attachment table|Main/WebHome#FileAttachmentTable]]. -- Files of any type can be uploaded. Some files that might impose a security risk are renamed, i.e. `*.php` files are renamed to `*.php.txt`. -- Currently there is no file size limit besides the disk space on the server. -- The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it again you can copy the previous upload path into the Local file field. +- To upload: Click on the **Attach** link at the bottom of each page. A form is shown where you can browse for a file and upload it. The uploaded file will show up in the [[File Attachment table|Main/WebHome#FileAttachmentTable]]. + +- - Files of any type can be uploaded. Some files that might impose a security risk are renamed, ex: `*.php` files are renamed to `*.php.txt`. + +- - Currently there is no file size limit besides the disk space on the server. + +- - The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field. ### Downloading Files - To download: Click on the file in the [[File Attachment table|Main/WebHome#FileAttachmentTable]]. -- There is no access control on individual attachments. If you need to have this type of control create separate topics and define access restrictions on the topics. + + + +- **_NOTE:_** There is no access control on individual attachments. If you need this type of control, create separate topics and define [[access restrictions|Main/TWikiDocumentation#TWikiAccessControl]] per topic. ### Moving Attachment Files -An attachement can be moved between topics. To do this click _action_ on the attachment to be moved. On the subsequent page select the new Web and Topic, the click _Move_. The attachment and its version history is moved. The original location is stored in the [[topic meta data|Main/TWikiDocumentation#Meta_Data_Definition]]. +An attachement can be moved between topics. To do this click **Action** on the attachment to be moved. On the control page, select the new web and topic, the click **Move**. The attachment and its version history are moved. The original location is stored as [[topic Meta Data|Main/TWikiDocumentation#Meta_Data_Definition]]. ### Deleting Attachments @@ -61,156 +70,157 @@ It is not possible to delete attached files with the current TWiki implementatio ### Linking to Attached Files - Once a file is attached it can be referenced in the topic. Example: - - Attach file: `Sample.txt` - - Edit topic and write text: `%ATTACHURL%/Sample.txt` - - Text is shown as: , ex: it is a link. - - To reference an attachment located in another topic write text: - - `%PUBURL%/%WEB%/OtherTopic/Sample.txt` (for same web) - - `%PUBURL%/Otherweb/OtherTopic/Sample.txt` (for different web) + 1. **Attach** file: `Sample.txt` + 2. **Edit** topic and write text: `%ATTACHURL%/Sample.txt` + 3. **Preview** - `%ATTACHURL` text appears as: , a link. + +- To reference an attachment located in another topic, write text: + - - `%PUBURL%/%WEB%/OtherTopic/Sample.txt` (for the same web) + - `%PUBURL%/Otherweb/OtherTopic/Sample.txt` (for adifferent web) - Attached HTML files and text files can be inlined in a topic. Example: - - Attach file: `Sample.txt` - - Edit topic and write text: `%INCLUDE{"%ATTACHURL%/Sample.txt"}%` - - Content of attached file is shown inlined. - - Read more in [[IncludeTopicsAndWebPages]]. + 1. **Attach** file: `Sample.txt` + 2. **Edit** topic and write text: `%INCLUDE{"%ATTACHURL%/Sample.txt"}%` + - Content of attached file is shown inlined. + - Read more in [[IncludeTopicsAndWebPages]]. - GIF, JPG and PNG images can be attached and shown embedded in a topic. Example: - - Attach file: `Smile.gif` - - Edit topic and write text: `%ATTACHURL%/Smile.gif` - - Text is shown as: ![Smile.gif](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%/Smile.gif) , it shows up as an image. + 1. **Attach** file: `Smile.gif` + 2. **Edit** topic and write text: `%ATTACHURL%/Smile.gif` + 3. **Preview** - text appears as ![Smile.gif](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%/Smile.gif), an image. ### File Attachment Contents Table -Is a table that looks like this: - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Attachment:Action:Size:Date:Who:Comment:
    Sample.txtaction 30 22 Jul 2000 - 19:37 PeterThoeny Just a sample
    Smile.gifaction 94 22 Jul 2000 - 19:38 PeterThoeny Smiley face
    -
    +Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click **Attach**. + +> +> +> +> +>
    +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +>
    Attachment:Action:Size:Date:Who:Comment:
    Sample.txtaction 30 22 Jul 2000 - 19:37 PeterThoeny Just a sample
    Smile.gifaction 94 22 Jul 2000 - 19:38 PeterThoeny Smiley face
    +>
    ### File Attachment Control Page -Clicking on an action link takes you to a new page that looks like this: - -
    - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Attachment:Action:Size:Date:Who:Comment:Attribute:
    Sample.txtaction 30 22 Jul 2000 - 19:37 PeterThoeny Just a sample  
    Smile.gifaction 94 22 Jul 2000 - 19:38 PeterThoeny Smiley face  
    -

    -

    -

    Update attachment Sample.txt

    -

    -

    - - - - - - - - - - - - - - - -
    Version:Action:Date:Who:Comment:
    1.1 view 2001.08.30.09.28.56 PeterThoeny  
    -

    -

    - - - - - - - - - - - - - - - - - - - - - -
    Previous
    upload:     		C:\DATA\Sample.txt (PeterThoeny)
    Local file:
    Comment:
    Link: Create a link to the attached file at the end of the topic.
    Hide file: Hide attachment in normal topic view.
    Help text ...

    Topic FileAttachment . {

    | | Move attachment | Cancel }
    -
    - -The first table is a list of all attachments, including their _attributes_. A `h` means the attachment is hidden i.e. isn't listed when viewing a topic. - -The second table is all the versions of the attachment. Click on `view` to see that version, if it is the most recent version you'll be taken to a URL that always displays the latest version, which is usually what you want to email out. - -If you just want to change the comment on an attachment - enter a new comment and then press _Change properties_. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change. - -Similarly to hide/unhide an attachment click in the _Hide file_ checkbox are press _Change properties_. +Clicking on an **Action** link takes you to a new page that looks like this: + +>
    +> +> +> +> +>
    +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +>
    Attachment:Action:Size:Date:Who:Comment:Attribute:
    Sample.txtaction 30 22 Jul 2000 - 19:37 PeterThoeny Just a sample  
    Smile.gifaction 94 22 Jul 2000 - 19:38 PeterThoeny Smiley face  
    +>

    +>

    +>

    Update attachment Sample.txt

    +>

    +>

    +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +>
    Version:Action:Date:Who:Comment:
    1.1 view 2001.08.30.09.28.56 PeterThoeny  
    +>

    +>

    +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +>
    Previous
    upload:     		C:\DATA\Sample.txt (PeterThoeny)
    Local file:
    Comment:
    Link: Create a link to the attached file at the end of the topic.
    Hide file: Hide attachment in normal topic view.
    Help text ...

    Topic FileAttachment . {

    | | Move attachment | Cancel }
    +>
    + +- The first table is a list of all attachments, including their attributes. An `h` means the attachment is hidden, it isn't listed when viewing a topic. + +- The second table is all the versions of the attachment. Click on **View** to see that version. If it's the most recent version, you'll be taken to an URL that always displays the latest version, which is usually what you want. + +- - **To change the comment** on an attachment, enter a new comment and then click **Change properties**. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change. + +- - **To hide/unhide** an attachment, enable the **Hide file** checkbox, then click **Change properties**. ### Known Issues diff --git a/TWiki/TextFormattingFAQ.mdwn b/TWiki/TextFormattingFAQ.mdwn index 6852cdf..13f6711 100644 --- a/TWiki/TextFormattingFAQ.mdwn +++ b/TWiki/TextFormattingFAQ.mdwn @@ -1,230 +1,240 @@ -**Text Formatting FAQ** - -This topic has answers to frequently asked questions about text formatting. [[TextFormattingRules]] has more on formatting rules in general. It also has links to HTML documentation. - -- [Q:](#sepa) How do I make a separator? -- [Q:](#head) How do I create a title or a heading? -- [Q:](#brac) Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is? -- [Q:](#ques) Some words (like [[WinAPI]]) have an unwanted question mark at the end. How can I prevent that? -- [Q:](#fixe) How can I write fixed font text? -- [Q:](#wrap) Text I enter gets wrapped around. How can I keep the formatting as it is? -- [Q:](#tabl) How do I create tables? -- [Q:](#imag) Can I include images and pictures? -- [Q:](#colo) Can I write colored text? - ----- - -Q: **How do I make a separator?** - -You can make a horizontal separator by writing 4 or more dashes at the beginning of a line. - ----- - -Q: **How do I create a title or a heading?** - -The most simple way is to enclose it in '\*' Asterisk characters or '\_' Underscore charcters. - -**This is an example header enclosed in Asterisk characters** - -_This is an example header enclosed in Underscore characters_ - -You could use also HTML tags for headings, e.g. `

    This is an HTML heading

    ` will show up as: - -#### This is an HTML heading - ----- - -Q: **Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?** - -TWiki interprets text as HTML. The '<' and '>' characters are used to define HTML commands. Any valid text within angle brackets gets interpreted by the browser as an HTML command. Invalid text is ignored, that's why it doesn't show up. - -There are two work arounds if you want to display angle brackets: - -- Do an escape sequence in HTML: - - Write `<` instead of `<` - - Write `>` instead of `>` - - Example: Write `(a > 0)` instead of `(a > 0)` -- Replace angle brackets with curly brackets. - - Example: Write `{is-writable}` instead of `` - ----- - -Q: **Some words (like [[WinAPI]]) have an unwanted question mark at the end. How can I prevent that?** - -A question mark after a word is a link to a not yet existing topic. For example, [[WinAPI]] is a valid [[WikiName]], but the actual topic _WinAPI_ does not exist. - -If you do not intend to create a topic for a valid [[WikiWord]], you can prevent it being linked by putting an HTML tag in front of it. I usually use <nop>. This is a non existing HTML tag, so a browser just ignores it. - -- Example text:
    `WinAPI as it is, WinAPI with preceeding NOP.` -- Example output:
    [[WinAPI]] as it is, WinAPI with preceeding NOP. - ----- - -Q: **How can I write fixed font text?** - -Enclose text in "=" equal signs. - -- Example text:
    `Proportional text, =fixed font text= , proportional again.` -- Example output:
    Proportional text, `fixed font text` , proportional again. - -Alternatively you could also use preformatted text, see next question for details. - ----- - -Q: **Text I enter gets wrapped around. How can I keep the formatting as it is?** - -TWiki interprets text as HTML. It is possible to use preformatted text to work around this. Use the preformatted HTML tags to keep the new line of text as it is. Do so by enclosing the text with <PRE> and </PRE> tags, e.g. - - This text will keep its format as it is: - 
    -      Unit	  Price	Qty  Cost
-      -------  ------  ---  ------
-      aaa		 12.00	 3	36.00
-
    - -It is recommended to use preformatting for tables and source code. - ----- - -Q: **How do I create tables?** - -There are three possibilities: - -1. Use Wiki rule with "|" vertical bars. -2. Use HTML tables with <TABLE>, <TR>, <TD> tags. -3. Use preformatted text with <PRE> tags. - -**\_1. Use Wiki rule with "|" vertical bars\_** - -- Example text:
    `| cell A1 | cell B1 | cell C1 |`
    `| cell A2 | cell B2 | cell C2 |` -- Example output: - - - - - - - - - - -
    cell A1 cell B1 cell C1
    cell A2 cell B2 cell C2
    - -**\_2. Use HTML tables with <TABLE>, <TR>, <TD> tags\_** - -This is a manual process using HTML commands. Here is an example. If you enter this: - - - - - - - - - -
    Head A Head B
    Cell A2 Cell B2
    Cell A3 Cell B3
    - -It is displayed as a table like this: - - - - - - - - - - - - - - -
    Head A Head B
    Cell A2 Cell B2
    Cell A3 Cell B3
    - -You can copy the example from <TABLE> to </TABLE> and change it to your needs. - -More information about HTML tables can be found at - -**\_3. Use preformatted text with <PRE> tags\_** - -See [Q:](#wrap) Text I enter gets wrapped around. How can I keep the formatting as it is? - ----- - -Q: **Can I include images and pictures?** - -Yes, this is possible. The easiest way of including images is to attach a GIF or JPG file to a topic and then to include it with text `%ATTACHURL%/myImage.gif` . [[FileAttachment]] has more. - -There are actually two ways of including inline images. - -**\_1. Using URL ending in .gif, .jpg, .jpeg\_** - -This is a simple and automatic way of including inline images. Simply write the URL of the image file, this will create the inline image for you. **Note:** The images must be accessible as a URL. - -- Example text:
    ` TWiki http://www.dementia.org/twiki//view/wikiHome.gif logo.` -- Example output:
    TWiki ![wikiHome.gif](http://www.dementia.org/twiki//view/wikiHome.gif) logo. - -**\_2. Using <IMG> tag\_** - -This is a manual process where you have more control over the rendering of the image. Use the <IMG> tag of HTML to include JPEG and GIF files. **Note:** The display of the topic is faster if you include the WIDTH and HEIGHT parameters that have the actual image size. has more on inline images. - -- Example text:
    `TWiki logo.` -- Example output:
    TWiki logo. - ----- - -Q: **Can I write colored text?** - -Place text you would like to specify a color inside <FONT COLOR="colorCode"> and </FONT> tags. - -"colorCode" is the hexadecimal RGB color code. The color is composed by specifying the red, green and blue components of the color in hexadecimal notation. For example, to specify white, the red, green and blue components are 255, 255, 255, so you would use "#FFFFFF". You can use [[StandardColors]] or common color codes: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Black: "#000000" Green: "#008000" Silver: "#C0C0C0" Lime: "#00FF00"
    Gray: "#808080" Olive: "#808000" White: "#FFFFFF" Yellow: "#FFFF00"
    Maroon: "#800000" Navy: "#000080" Red: "#FF0000" Blue: "#0000FF"
    Purple: "#800080" Teal: "#008080" Fuchsia: "#FF00FF" Aqua: "#00FFFF"
    - -- Example text:
    ` Red color draws attention. ` -- Example output:
    Red color draws attention. - ----- +**Text Formatting FAQ** + +- The most frequently asked questions about text formatting are answered here. + - [[TextFormattingRules]] has the complete system in a handy quick reference format. + + + +> ---- +> +> ### How do I make a separator? +> +> You can make a horizontal separator by writing 4 or more dashes at the beginning of a line. +> +> ---- +> +> ### How do I create a title or a heading? +> +> The most simple way is to enclose it in '\*' Asterisk characters or '\_' Underscore characters. +> +> **This is an example header enclosed in Asterisk characters** +> +> _This is an example header enclosed in Underscore characters_ +> +> You could use also HTML tags for headings, e.g. `

    This is an HTML heading

    ` will show up as: +> +> #### This is an HTML heading +> +> ---- +> +> +> +> ### Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is? +> +> TWiki interprets text as HTML. The '<' and '>' characters are used to define HTML commands. Any valid text within angle brackets gets interpreted by the browser as an HTML command. Invalid text is ignored, that's why it doesn't show up. +> +> There are two work arounds if you want to display angle brackets: +> +> - Do an escape sequence in HTML: +> - Write `<` instead of `<` +> - Write `>` instead of `>` +> - Example: Write `(a > 0)` instead of `(a > 0)` +> - Replace angle brackets with curly brackets. +> - Example: Write `{is-writable}` instead of `` +> +> ---- +> +> ### Some words (like [[WinAPI]]) have an unwanted question mark at the end. How can I prevent that? +> +> A question mark after a word is a link to a not yet existing topic. For example, [[WinAPI]] is a valid [[WikiName]], but the actual topic _WinAPI_ does not exist. +> +> If you do not intend to create a topic for a valid [[WikiWord]], you can prevent it being linked by putting an HTML tag in front of it. I usually use <nop>. This is a non existing HTML tag, so a browser just ignores it. +> +> - Example text:
    `WinAPI as it is, WinAPI with preceding NOP.` +> - Example output:
    [[WinAPI]] as it is, WinAPI with preceding NOP. +> +> ---- +> +> ### How can I write fixed font text? +> +> Enclose text in "=" equal signs. +> +> - Example text:
    `Proportional text, =fixed font text= , proportional again.` +> - Example output:
    Proportional text, `fixed font text` , proportional again. +> +> Alternatively you could also use preformatted text, see next question for details. +> +> ---- +> +> ### Text I enter gets wrapped around. How can I keep the formatting as it is? +> +> TWiki interprets text as HTML. It is possible to use preformatted text to work around this. Use the preformatted HTML tags to keep the new line of text as it is. Do so by enclosing the text with <PRE> and </PRE> tags, e.g. +> +> This text will keep its format as it is: +> 
    +>       Unit	  Price	Qty  Cost
+>       -------  ------  ---  ------
+>       aaa		 12.00	 3	36.00
+>
    +> +> It is recommended to use preformatting for tables and source code. +> +> ---- +> +> ### How do I create tables? +> +> There are three possibilities: +> +> 1. Use Wiki rule with "|" vertical bars. +> 2. Use HTML tables with <TABLE>, <TR>, <TD> tags. +> 3. Use preformatted text with <PRE> tags. +> +> **\_1. Use Wiki rule with "|" vertical bars\_** +> +> - Example text:
    `| cell A1 | cell B1 | cell C1 |`
    `| cell A2 | cell B2 | cell C2 |` +> - Example output: +> +> +> +> +> +> +> +> +> +> +>
    cell A1 cell B1 cell C1
    cell A2 cell B2 cell C2
    +> +> **\_2. Use HTML tables with <TABLE>, <TR>, <TD> tags\_** +> +> This is a manual process using HTML commands. Here is an example. If you enter this: +> +> +> +> +> +> +> +> +> +>
    Head A Head B
    Cell A2 Cell B2
    Cell A3 Cell B3
    +> +> It is displayed as a table like this: +> +> +> +> +> +> +> +> +> +> +> +> +> +> +>
    Head A Head B
    Cell A2 Cell B2
    Cell A3 Cell B3
    +> +> You can copy the example from <TABLE> to </TABLE> and change it to your needs. +> +> More information about HTML tables can be found at +> +> **\_3. Use preformatted text with <PRE> tags\_** +> +> Text I enter gets wrapped around. How can I keep the formatting as it is? See [["Text enclosed..."|Main/WebHome#TextEnclosed]] +> +> ---- +> +> ### Can I include images and pictures? +> +> Yes, this is possible. The easiest way of including images is to attach a GIF or JPG file to a topic and then to include it with text `%ATTACHURL%/myImage.gif` . [[FileAttachment]] has more. +> +> There are actually two ways of including inline images. +> +> **\_1. Using URL ending in .gif, .jpg, .jpeg\_** +> +> This is a simple and automatic way of including inline images. Simply write the URL of the image file, this will create the inline image for you. **Note:** The images must be accessible as a URL. +> +> - Example text:
    ` TWiki http://www.dementia.org/twiki//view/wikiHome.gif logo.` +> - Example output:
    TWiki ![wikiHome.gif](http://www.dementia.org/twiki//view/wikiHome.gif) logo. +> +> **\_2. Using <IMG> tag\_** +> +> This is a manual process where you have more control over the rendering of the image. Use the <IMG> tag of HTML to include JPEG and GIF files. **Note:** The display of the topic is faster if you include the WIDTH and HEIGHT parameters that have the actual image size. has more on inline images. +> +> - Example text:
    `TWiki logo.` +> - Example output:
    TWiki logo. +> +> ---- +> +> ### Can I write colored text? +> +> Place text you would like to specify a color inside <FONT COLOR="colorCode"> and </FONT> tags. +> +> "colorCode" is the hexadecimal RGB color code. The color is composed by specifying the red, green and blue components of the color in hexadecimal notation. For example, to specify white, the red, green and blue components are 255, 255, 255, so you would use "#FFFFFF". You can use [[StandardColors]] or common color codes: +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +> +>
    Black: "#000000" Green: "#008000" Silver: "#C0C0C0" Lime: "#00FF00"
    Gray: "#808080" Olive: "#808000" White: "#FFFFFF" Yellow: "#FFFF00"
    Maroon: "#800000" Navy: "#000080" Red: "#FF0000" Blue: "#0000FF"
    Purple: "#800080" Teal: "#008080" Fuchsia: "#FF00FF" Aqua: "#00FFFF"
    +> +> - Example text:
    ` Red color draws attention. ` +> - Example output:
    Red color draws attention. +> +> ---- -- [[PeterThoeny]] - 18 Aug 2000